Python SDK to interface with the KUSANAGI™ framework (http://kusanagi.io).
- KUSANAGI framework 5.0+
- Python 3.9+
- libzmq 4.3.4+
Enter the following command to install the SDK in your local environment:
$ pip install kusanagi-sdk-python
Poetry is required to run the test, coverage and linting.
The tests run using pytest:
$ poetry run pytest
Or to run the tests with coverage:
$ poetry run pytest --cov=kusanagi
Alternativelly the tests and coverage can be run for the supported python versions though tox by running:
$ tox
See the getting started tutorial to begin with the KUSANAGI™ framework and the Python SDK.
See the API for a technical reference of the SDK.
For help using the framework see the documentation.
Please first read our contribution guidelines.
We use milestones to track upcoming releases inline with our versioning strategy, and as defined in our roadmap.
If you'd like to know how you can help and support our Open Source efforts see the many ways to get involved.
Please also be sure to review our community guidelines.
Copyright 2016-2023 KUSANAGI S.L. (http://kusanagi.io). All rights reserved.
KUSANAGI, the sword logo and the "K" logo are trademarks and/or registered trademarks of KUSANAGI S.L. All other trademarks are property of their respective owners.
Licensed under the MIT License. Redistributions of the source code included in this repository must retain the copyright notice found in each file.
