Getting Started with pykiso for contributors
Requirements
Python 3.6+
pipenv (used to get the rest of the requirements)
Install
git clone https://github.com/eclipse/kiso-testing.git
cd kiso-testing
pipenv install --dev
pipenv shell
Pre-Commit
To improve code-quality, a configuration of pre-commit hooks are available. The following pre-commit hooks are used:
black
trailing-whitespace
end-of-file-fixer
check-docstring-first
check-json
check-added-large-files
check-yaml
debug-statements
flake8
isort
If you don’t have pre-commit installed, you can get it using pip:
pip install pre-commit
Start using the hooks with
pre-commit install
Demo using example config
invoke run
Running the Tests
invoke test
or
pytest
Building the Docs
invoke docs