CONTRIBUTING.md

Contributing

Before getting started, make sure you have Poetry.

Install

# Install project
poetry install -E crypto

# Enter poetry-managed venv
poetry shell

# Exit poetry-managed venv
exit

Tasks

We use poethepoet as a task runner. To see available tasks:

$ poe --help
...
  clean          Remove build artifacts
  lint           Run linters and formatters
  test           Run tests

Code Quality

To ensure code quality, we use the following tools:

• Formatting: black and isort
• Linting: flake8 and mypy
• Testing: pytest

Our CI pipeline will run these tools on each commit. To run these locally, we recommend pre-commit:

poetry run pre-commit install

Updating the Nionic Graphql artifacts

poetry shell

python3 -m sgqlc.introspection --exclude-deprecated --exclude-description http://localhost:3000/graphql graphql/nionic_schema.json

sgqlc-codegen schema graphql/nionic_schema.json contxt/generated/nionic_schema.py

sgqlc-codegen operation --schema graphql/nionic_schema.json .nionic_schema contxt/generated/nionic_queries.py graphql/nionic_queries.graphql

Create Release

On a commit to main, our CI pipeline will bump the version (determined by conventional commits) and publish a new release to PyPI.