Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.17 KB

Setting up a development environment

The orb_models repository uses uv for dependency management. To install the package and its dependencies, run the following command:

pipx install uv  # If you don't have uv, we recommend installing it into an isolated environment with pipx: https://docs.astral.sh/uv/getting-started/installation/#pypi
uv sync --group dev  # Install orb-models and development packages

Running linters

The orb_models repository uses ruff for formatting and linting, and mypy for type checking. To run the linters, use the following commands:

ruff format .   # Format code
ruff check .    # Check for linting errors
mypy .          # Run type checking

Running tests

The orb_models repository uses pytest for testing. To run the tests, navigate to the root directory of the package and run the following command:

pytest -n auto ./tests/

Publishing

The orb_models package is published using trusted publishers. Whenever a new release is created on GitHub, the package is automatically published to PyPI using GitHub Actions.