Skip to content

Latest commit

 

History

History
62 lines (34 loc) · 1.31 KB

CONTRIBUTING.rst

File metadata and controls

62 lines (34 loc) · 1.31 KB

Contributing Guidelines

Since version v0.8 (to-be-released), pushbullet-cli supports python versions from 3.5 to 3.7. Dropping support to python <=2.7

You can see test information and coverage reports in README

Dependencies

Pipenv is used to manage python dependencies and virtual environment.

To install all the required tools, run:

$ pipenv install -d

To activate the newly created environment, run:

$ pipenv shell

This will spawn a new shell with the environment activated.

Important! Please remember to keep the Pipfile and Pipfile.lock in sync.

Tools

We use yapf and * isort* to format all the code. A task ( pyinvoke ) is provided to automate this process.

$ inv format

Will format the necessary code with the pre-configured settings.

Also git pre-commit hooks are provided to make sure everything is in order before commiting and pushing.

You can install the hooks with:

$ inv install-hooks

Testing

Tests are handled with pytest.

$ inv test [--nocov]

Will run all the tests. The flag --nocov will disable coverage reports.