Welcome to sarge’s documentation!
Release: |
0.1.8.dev0 |
---|---|
Date: |
Oct 25, 2024 |
Welcome to the documentation for sarge
, a wrapper for subprocess
which aims to make life easier for anyone who needs to interact with external
applications from their Python code.
Please note: this documentation is work in progress.
- Overview
- Tutorial
- Installation and testing
- Common usage patterns
- Passing input data to commands
- Chaining commands conditionally
- Creating command pipelines
- Using redirection
- Capturing
stdout
andstderr
from commands - Iterating over captures
- Interacting with child processes
- Environments
- Working directory and other options
- Unicode and bytes
- Use as context managers
- Synchronous and asynchronous execution of commands
- Handling errors in asynchronous mode
- About threading and forking on POSIX
- Next steps
- Under the hood
- API Reference
Please report any problems or suggestions for improvement either via the mailing list or the issue tracker.