Metadata-Version: 2.1
Name: charmonium.async-subprocess
Version: 0.1.5
Summary: async clone of subprocess.run
Home-page: https://github.com/charmoniumQ/charmonium.async_subprocess.git
License: MIT
Keywords: async,subprocess,shell
Author: Samuel Grayson
Author-email: sam@samgrayson.me
Requires-Python: >=3.7,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries
Project-URL: Repository, https://github.com/charmoniumQ/charmonium.async_subprocess.git
Description-Content-Type: text/x-rst

charmonium.async_subprocess
===========================

See the documentation of the main function::

   async def run(
       args: Sequence[StrBytes],
       cwd: Optional[Path] = None,
       env: Optional[Union[Mapping[StrBytes, StrBytes]]] = None,
       env_override: Optional[Mapping[StrBytes, StrBytes]] = None,
       capture_output: bool = False,
       check: bool = False,
       text: Optional[bool] = None,
   ) -> subprocess.CompletedProcess:
       """An async clone of `subprocess.run`.
   
       Suppose you have Python script that orchestrates shell commands,
       but it's too slow, and you've identified commands which can run in
       parallel. You could use `threading`, but that has GIL problems, or
       `multiprocess`, which has a high startup-cost per worker. You are
       already spinning off subprocesses, which the OS will run
       concurrently, so why not use async/await programming to express
       concurrency in a single thread?
   
       Note this function does not permit you to communicate
       asynchronously, just to run commands asynchronously.
   
       This function supports a subset of the signature of
       `subprocess.run`, that I will expand based on need. If you need
       some functionality, submit an issue or PR.
   
       """

