Contributor Guide

Thank you for your interest in improving this project. This project is open-source under the Apache 2.0 license and welcomes contributions in the form of bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to update this repository

This repository is created using cookiecutter and the hypermodern-python template from cjolowicz.github.io and also borrows from [cookiecutter-modern-pypackage] (https://github.com/fedejaure/cookiecutter-modern-pypackage)

This repository should be maintained and updated according to the [repository maintenance (hypermodern)] and [repository maintenance (modern-pypackage)] guides.

How to report a bug

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?

  • Which version of this project are you using?

  • What did you do?

  • What did you expect to see?

  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue.

How to request a feature

Request features on the Issue Tracker.

How to set up your development environment

You will need Python 3.8+ (installed via pyenv, preferably) and the following tools:

Install the package along with all the development requirements:

$ poetry install

Initialize the .pre-commit hooks:

$ poetry run pre-commit install --install-hooks

This project relies on ruff for linting and code formatting, you can install it on vs-code from ruff-lsp-code

You can now run an interactive Python session, with the package installed:

>>> from peak.resources import workflows

>>> WorkflowClient = workflows.Client()

Remember to have a proper initialization of nbstripout in your local environment if you are working with jupyter notebooks in the ./examples folder, you can do so by running the command:

$ nbstripout --install --attributes .gitattributes

This will ensure that the notebooks are stripped of their outputs before being committed to the repository.

How to test the project

You have the option ot either use the built-in make commands or invoke nox directly

Launch a live sphinx build server with make that watches the local filesystem for changes:

$ make autodocs

Perform a one-time docs rebuild with sphinx

$ make builddocs

Run the full test suite with make:

$ make tests

Visualize coverage with make:

$ make coverage

Run the full test suite with nox:

$ nox

List the available nox sessions:

$ nox --list-sessions

You can also run a specific nox session. For example, invoke the unit test suite like this:

$ nox --session=tests

Unit tests are located in the tests directory, and are written using the pytest testing framework.

Resolving false positives in detect-secrets pre-commit scans

  • Once, installed detect-secrets from pipx[recommended], it can be used to scan for secrets in the codebase, it uses a baseline file to ignore false positives, the baseline file is sourced from .secrets.baseline and can be updated by running the following command, to suppress false positives.

    $> detect-secrets scan > .secrets.baseline

How to submit changes

Open a new pull request with development as base branch to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The Nox test suite must pass without errors and warnings.

  • Include unit tests. This project maintains 100% code coverage.

  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.

To run linting and code formatting checks before committing your change, you can install pre-commit as a Git hook by running the following command:

$ nox --session=pre-commit -- install

Feature pull request should always be based from development branch. After approvals on the PR, it can be merged to development. The required changes will then be tested and can be merged to main.

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.