pipes-cliff: Streaming to and from subprocesses using Pipes
pipes-cliff helps you spawn subprocesses and send data to and from them with the Pipes library. Subprocesses are opened using the process library, and you stream data in and out using the various Pipes abstractions.
Though this library uses the Pipes library, I have not coordinated with the author of the Pipes library in any way. Any bugs or design flaws are mine and should be reported to
http://www.github.com/massysett/pipes-cliff/issues
For more information, see the README.md file, which is located in the source tarball and at
https://github.com/massysett/pipes-cliff
[Skip to Readme]
Flags
Manual Flags
| Name | Description | Default |
|---|---|---|
| tests | Build test executables | Disabled |
Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info
Downloads
- pipes-cliff-0.12.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.2.0.0, 0.4.0.0, 0.6.0.0, 0.8.0.0, 0.8.0.2, 0.10.0.0, 0.10.0.2, 0.10.0.4, 0.12.0.0 |
|---|---|
| Dependencies | async (>=2.0), base (>=4.9 && <5), bytestring (>=0.10.4), pipes (>=4.1), pipes-safe (>=2.2), process (>=1.2.0.0), stm (>=2.4.4), unix (>=2.7.2) [details] |
| License | BSD-3-Clause |
| Copyright | Copyright (c) 2015-2016 Omari Norman |
| Author | Omari Norman |
| Maintainer | omari@smileystation.com |
| Category | Pipes, Concurrency |
| Home page | http://www.github.com/massysett/pipes-cliff |
| Bug tracker | http://www.github.com/massysett/pipes-cliff/issues |
| Source repo | head: git clone https://github.com/massysett/pipes-cliff.git |
| Uploaded | by OmariNorman at 2016-07-16T19:33:30Z |
| Distributions | NixOS:0.12.0.0 |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Executables | standardOutputAndError, alphaNumbersByteString, limitedAlphaNumbers, alphaNumbers, numsToLess |
| Downloads | 6640 total (25 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating | |
| Status | Docs available [build log] Last success reported on 2016-07-16 [all 1 reports] |
Readme for pipes-cliff-0.12.0.0
[back to package description]pipes-cliff
pipes-cliff helps you spawn subprocesses and send data to and from them with the Pipes library. Subprocesses are opened using the process library, and the processes and handles are properly cleaned up even if there are exceptions.
Though this library uses the Pipes library, I have not coordinated with the author of the Pipes library in any way. Any bugs or design flaws are mine and should be reported to
http://www.github.com/massysett/pipes-cliff/issues
Though I hope pipes-cliff works on Windows systems, I have only tested it on Unix-like systems. Any reports on how this library works on Windows are appreciated.
Building pipes-cliff
If you get the files from Hackage, just build them in the usual way using cabal-install.
To build the files from Github, you will need to generate the Cabal file. The Cabal file is generated using the Cartel package, so first run
cabal install cartel
and then, from the main directory (the one with the generate script), run
sh generate
(at least, this is how you would do it on a Unix-like system.)
If you are having trouble getting pipes-cliff to build, examine the build history here:
Previous builds will show you the dependencies that were used in the past to build the library.
Why the name?
It's named after Cliff Clavin, the mailman on the TV show Cheers. pipes-cliff uses mailboxes to send information to and from subprocesses.
The obvious name, pipes-process, has already been taken. At the time of this writing, I saw at least two libraries with this name, though neither was posted to Hackage.
Similar libraries
Take a look at these other libraries; they might meet your needs.
Dealing specifically with subprocesses and streaming
- process-streaming
http://hackage.haskell.org/package/process-streaming
- pipes-shell
https://hackage.haskell.org/package/pipes-shell
- Data.Conduit.Process
https://www.fpcomplete.com/user/snoyberg/library-documentation/data-conduit-process
Larger scripting frameworks
- HSH
https://hackage.haskell.org/package/HSH
- Turtle
https://hackage.haskell.org/package/turtle
- Shelly
https://hackage.haskell.org/package/shelly
Also, look at this discussion on the Pipes mailing list:
https://groups.google.com/d/msg/haskell-pipes/JFfyquj5HAg/Lxz7p50JOh4J
License
This package is released under the BSD3 license. Please see the LICENSE file.
Building this project
The Cabal file for this project is generated using the Cartel package.
To generate the Cabal file, simply run sh buildprep.
You must run this command from the project's main directory.
You will need to have the stack program installed.
Stack is available at: http://www.haskellstack.org