mbarbin/eio-process
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Extending the [Eio.Process] api to spawn external processes
60 commits 2 branches 4 tags 771 KiB
  • OCaml 84.6%
  • Dune 12.3%
  • Makefile 3.1%
Find a file
Exact
Mathieu Barbin e09fc0b3f5
 Prepare to archive
2025-02-21 10:54:37 +01:00
.github Add new CI jobs (compiler x platform) 2025-01-10 11:41:25 +01:00
.vscode Init 2024-02-25 09:56:21 +01:00
src Upgrade ocamlformat to 0.27.0 2024-12-03 19:15:24 +01:00
test Fix extract lint rules from pp 2025-01-10 12:44:29 +01:00
.gitattributes Init 2024-02-25 09:56:21 +01:00
.gitignore Update .gitignore 2024-04-10 14:59:15 +02:00
.ocamlformat Add ocaml-version to ocamlformat config according to the project lower bound 2025-01-10 11:41:25 +01:00
CHANGES.md Split test-package and add with-dev-setup deps 2024-09-08 18:24:36 +02:00
dune Init 2024-02-25 09:56:21 +01:00
dune-project Disable implicit transitive dependencies 2024-12-16 10:34:43 +01:00
eio-process-tests.opam Require dune.3.17 2024-12-16 10:34:43 +01:00
eio-process.opam Require dune.3.17 2024-12-16 10:34:43 +01:00
LICENSE Init 2024-02-25 09:56:21 +01:00
LICENSE.eio Init 2024-02-25 09:56:21 +01:00
LICENSE.janestreet Init 2024-02-25 09:56:21 +01:00
Makefile Split test-package and add with-dev-setup deps 2024-09-08 18:24:36 +02:00
README.md Prepare to archive 2025-02-21 10:54:37 +01:00

README.md

eio-process

CI Status Coverage Status

⚠️ This repository is now a public archive. I have stopped developping the eio-process project and will not be maintaining it forward.

This is an experimental library to spawn external processes in Eio with an api that resembles Async.Process.

This project re-uses some function and type names from the Async_unix.Process interface. The implementation however is quite different, since the original runs in the Async monad, whereas this lib targets Eio.

Motivation

We find that this API offers convenient wrappers that we believe are a good fit on top of the core functionality offered by Eio.Process.

Usage

Eio_process is meant to be used directly as a top-level module, alongside other Eio modules. We do not recommend shadowing Eio.Process with Eio_process in user code at this time.

Acknowledgements

We would like to express our gratitude to the Eio developers for their work on the eio project, and for the original module Eio.Process that this project extends. Eio is released under the terms of an ISC License. Its copyright and permission notice are included at the root of this project, in the file LICENSE.eio.

We also appreciate the work done by the async team at Jane Street and their contribution to the open source community. We're thankful for the api exposed by the Async_unix.Process module which we took inspiration from in this project. Async_unix is released under the terms of an MIT License. Its copyright and permission notice are included at the root of this project, in the file LICENSE.janestreet.

Code Documentation

The code documentation of the latest release is built with odoc and published to GitHub pages here.