Installation
To install the package, just run
pip install syncstream
The basic tier of this package does not require any dependencies. It only supports the syncstream for the multi-thread and the multi-process cases.
Extra features
The basic package would not contain the file and host modules. To install the package, please use the following options:
pip install syncstream[option1,option2...]
| Option | |
|---|---|
file | Install dependencies for the file module. The module provides syncstream.LineFileBuffer. |
host | Install dependencies for the host module. The module provides syncstream.LineHostBuffer, and syncstream.LineHostMirror. |
test | Install dependencies for running tests. |
dev | Install dependencies for developers. |
Install the GitHub version
The GitHub version may be newer than the PyPI version during the development. If users want to install the GitHub version, please ensure that Git has been installed.
After that, run the following command to install the developer's version.
pip install git+https://github.com/cainmagi/sync-stream.git
Run the tests
To verify whether the package is compatible with your device, please clone the project and run the tests:
git clone https://github.com/cainmagi/sync-stream.git
cd sync-stream
pip install -r requirements.txt -r tests/requirements.txt -r requirements-file.txt -r requirements-host.txt
python -m pytest
The package is only compatible with python>=3.6. If you find the package fails to pass the tests, please