Contributing

To develop your code contribution, clone the repository and install a local version of CharonLoad in your Python environment:

python -m pip install --editable ".[dev]"

We recommend to use editable mode for installable so your changes will become immediately visible.

Commands

CharonLoad uses nox to handle common tasks like running code formatters, linters, documentation creation, unit testing, etc.

To execute a specific task, run the following commands in the root directory of the cloned repository:

• Code Formatting

  nox -s format
  

• Code Linting

  nox -s lint
  

• Documentation Creation

  nox -s docs
  

• Documentation Creation with Live Update

  nox -s docs_live
  

• Unit Tests

  nox -s tests
  

• Code Coverage

  nox -s coverage
  

• Clean Up Project Directory

  nox -s clean