Contributing
Thank you for your interest in contributing to the Kumiho Python SDK!
Development Setup
Clone the repository:
git clone https://github.com/kumihoclouds/kumiho-python.git cd kumiho-python/python
Create a virtual environment:
python -m venv venv source venv/bin/activate # On Windows: venv\Scripts\activate
Install in development mode:
pip install -e ".[dev,docs]"
Run tests:
pytest
Code Style
Follow PEP 8 style guidelines
Add type hints to all public functions and methods
Run
mypyfor type checking:mypy kumiho
Documentation
Build the documentation locally:
cd docs
make html
View at docs/_build/html/index.html.
Testing
Write tests for all new functionality
Use
pytestfixtures for common setupRun the full test suite before submitting PRs:
pytest --cov=kumiho
Pull Request Process
Fork the repository
Create a feature branch:
git checkout -b feature/my-featureMake your changes with tests and documentation
Run linting and tests
Submit a pull request
License
By contributing, you agree that your contributions will be licensed under the Apache 2.0 License.