Developing & Contributing
📖 Development Guide¶
This document describes how to easily set up your local dev environment to work on StreamPipes Python 🐍.
🚀 First Steps¶
1) Set up your Python environment
Create a virtual Python environment using a tool of your choice. To manage dependencies, we use Poetry, so please install poetry in your local environment, e.g. via
pip install poetry
Once poetry is installed you can simply finalize your Python environment by running:
poetry install --with dev,stubs # install everything that is required for the development poetry install --with docs # install everything to work with the documentation poetry install --with dev,stubs,docs # install all optional dependencies related to development
2) Install pre-commit hook
The pre-commit hook is run before every commit and takes care about code style, linting, type hints, import sorting, etc. It will stop your commit in case the changes do not apply the expected format. Always check to have the recent version of the pre-commit hook installed otherwise the CI build might fail. If you are interested, you can have a deeper look on the underlying library: pre-commit.
Below we list some conventions that we have agreed on for creating StreamPipes Python. Please comply to them when you plan to contribute to this project. If you have any other suggestions or would like to discuss them, we would be happy to hear from you on our mailing list firstname.lastname@example.org or in our discussions on GitHub.
numpy style for Python docstrings 📄
Please stick to the
numpy style when writing docstrings, as we require this for generating our documentation.
2) Provide tests ✅
We are aiming for broad test coverage for the Python package and have therefore set a requirement of at least 90% unit test coverage. Therefore, please remember to write (unit) tests already during development. If you have problems with writing tests, don't hesitate to ask us for help directly in the PR or even before that via our mailing list (see above).
3) Build a similar API as the Java client provides 🔄
Whenever possible, please try to develop the API of the Python library the same as the Java client or Java SDK. By doing so, we would like to provide a consistent developer experience and the basis for automated testing in the future.
📦 Dependency Management¶
In case you want to add a new dependency to StreamPipes you can use the following command:
poetry add <dep-name>
If the dependency is only required for development purpose or the documentation, please stick to one the following:
poetry add <dep-name> --group dev poetry add <dep-name> --group stubs poetry add <dep-name> --group docs
In case you want to regenerate the poetry lock file, e.g., in case you manually updated the
the following command should be used:
poetry lock --no-update
After that, you should install the current version of the poetry lock file to keep your local environment consistent (see command above.)
To build our documentation, we use Materials for MkDocs.
All files can be found within the
To pre-view your local version of the documentation, you can use the following command:
Broadly speaking, we plan to expand or add new aspects/functionality to the library where we are focusing on the following:
- increase coverage of StreamPipes API 🔗
- build a comprehensive function zoo 🐘
- support more messaging broker 📬
- possibility to build pipeline elements 🔧
In case you want to have a more detailed look on what we are currently planning, have a look at our open issues(more short-term driven).
Of course, contributions are always highly appreciated 🔮
Before opening a pull request, review the Get Involved page. It lists information that is required for contributing to StreamPipes.
When you contribute code, you affirm that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.