Development - Contributing

Requirements

poetry: For dependency management and packaging in Python
pre-commit: For identifying code issues before submission to code review

Developing

To start working on this project, here are some guidelines to set up your environment:

git clone https://github.com/anancarv/python-artifactory.git
cd python-artifactory
Install poetry
Activate virtualenvpoetry shell
Install dependencies: poetry install
Run pre-commit install --install-hooks to install precommit hooks

After having installed pre-commit, before each commit, pre-commit hooks are run to:

check code formatting
detect secrets
create TOC in README
check code typing
find common security issues in Python code

Tests

Tests are run with Pytest.

pytest --cov=pyartifactory --cov-branch

Please, make sure to write tests for each feature you want to implement.