Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (35 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

47 lines (35 loc) · 1.27 KB
Raw

Contributing

GitHub Actions runs the automated checks for pull requests and publishes releases to PyPI.

For local development, install the dependencies with Poetry and run the unit tests with pytest. The test suite runs against all supported Python versions in CI.

Installation

To setup your environment:

  1. Install Python
  2. Install Pyenv
brew update
brew install pyenv
  1. Install your favorite Python version (>= 3.10 please!)
pyenv install <YOUR_FAVORITE_VERSION>
  1. Install Poetry, see: https://python-poetry.org/docs/#installation
  2. Install Dependencies
poetry install -v

Cloning the Repo

This repo contains the submodule mauth-protocol-test-suite so requires a flag when initially cloning in order to clone and init submodules:

git clone --recurse-submodules git@github.com:mdsol/mauth-client-python.git

If you have already cloned before the submodule was introduced, then run:

cd tests/mauth-protocol-test-suite
git submodule update --init

to init the submodule.

Unit Tests

  1. Make any changes, update the tests and then run tests with poetry run pytest.
  2. Coverage report can be viewed using open htmlcov/index.html.
  3. To run a specific test file, use poetry run pytest <SOME_FILE>.