Contributing to Protean

Thank you for considering contributing to Protean!

Support questions

Please don’t use the issue tracker for this. The issue tracker is a tool to address bugs and feature requests in Protean itself. Use one of the following resources for questions about using Protean or issues with your own code:

Reporting issues

Include the following information in your issue:

  • Describe what you expected to happen.

  • If possible, include a minimal reproducible example to help us identify the issue. This also helps check that the issue is not with your own code.

  • Describe what actually happened. Include the full traceback if there was an exception.

  • List your Python and Protean versions. If possible, check if this issue is already fixed in the latest releases or the latest code in the repository.

Submitting patches

If there is not an open issue for what you want to submit, prefer opening one for discussion before working on a PR. You can work on any issue that doesn’t have an open PR linked to it or a maintainer assigned to it. These show up in the sidebar. No need to ask if you can work on an issue that interests you.

Include the following in your patch:

  • Use Black to format your code. This and other tools will run automatically if you install pre-commit using the instructions below.

  • Include tests if your patch adds or changes code. Make sure the test fails without your patch.

  • Update any relevant docs pages and docstrings. Docs pages and docstrings should be wrapped at 72 characters.

  • Add an entry in CHANGES.rst. Use the same style as other entries. Also include .. versionchanged:: inline changelogs in relevant docstrings.

First time setup

  • Download and install the latest version of git.

  • Configure git with your username and email.

    $ git config --global 'your name'
    $ git config --global 'your email'
  • Make sure you have a GitHub account.

  • Fork Flask to your GitHub account by clicking the Fork button.

  • Clone the main repository locally.

    $ git clone
    $ cd protean
  • Add your fork as a remote to push your work to. Replace {username} with your username. This names the remote “fork”, the default Protean remote is “origin”.

    $ git remote add fork{username}/flask
  • Create a virtualenv.

    $ python3 -m venv env
    $ . env/bin/activate
  • Upgrade pip and setuptools.

    $ python -m pip install --upgrade pip setuptools
  • Install the development dependencies, then install Protean in editable mode.

    $ pip install -e .[all] && pip install -e .
  • Install the pre-commit hooks.

    $ pre-commit install

Start coding

  • Create a branch to identify the issue you would like to work on. If you’re submitting a bug or documentation fix, branch off of the latest “.x” branch.

    $ git fetch origin
    $ git checkout -b your-branch-name origin/0.6.x

    If you’re submitting a feature addition or change, branch off of the “master” branch.

    $ git fetch origin
    $ git checkout -b your-branch-name origin/master
  • Using your favorite editor, make your changes, committing as you go.

  • Include tests that cover any code changes you make. Make sure the test fails without your patch. Run the tests as described below.

  • Push your commits to your fork on GitHub and create a pull request. Link to the issue being addressed with fixes #123 or closes #123 in the pull request.

    $ git push --set-upstream fork your-branch-name

Running the tests

Run the basic test suite:

$ make test

This runs the tests with default adapters, which is usually sufficient. CI will run the full suite when you submit your pull request.

If you want to test Protean against all adapters, you can run the full test suite after bringing up the Docker containers running database and message broker services.

$ make test-full

Running test coverage

Generating a report of lines that do not have test coverage can indicate where to start contributing. Run pytest using coverage and generate a report.

$ make cov

Open htmlcov/index.html in your browser to explore the report.

Read more about coverage.

Building the docs

Build the docs in the docs-sphinx directory using Sphinx.

$ make html

Open build/html/index.html in your browser to view the docs.

Read more about Sphinx.