contributing.rst

Contributing

Python, version > 3.9

You need Python 3.9 or newer.

Setup

1. Run pipenv install --dev to install the Python environment in the project directory
2. Run pipenv run pre-commit install to install the pre commit hooks to git. Now every time you commit a change, the linters are run.
   • To run the pre commit checks manually: pipenv run pre-commit run --all-files

Scripts

• ` <./make_package.sh>`__ - Linux, OS X: build the Obs2Org PyPI package
• ./make_package.bat - Windows: build the Obs2Org PyPI package. This is disabled on Windows, because the scripts would not be executable because of the Windows filesystem.
• ./run_local_linters.sh - Linux, OS X: run all configured linters on the Source code and tests.
• ./run_local_linters.bat - Windows: run all configured linters on the Source code and tests.
• ./run_tests.sh - Linux, OS X: run all tests.
• ./run_tests.bat - Windows: run all tests.

Documentation

Ths source files for the Read the Docs site are located in the directory ./obs2org/doc/source

Sources

The sources of the program are in the directory ./obs2org/, the test sources and fixtures in ./tests/