Skip to content

Latest commit

 

History

History
31 lines (23 loc) · 930 Bytes

Development Setup.md

File metadata and controls

31 lines (23 loc) · 930 Bytes

Development Setup

This library uses Poetry to handle setting up for development and uploading the package to PyPi.

Note: Installing this library requires poetry >= 1.2.0. This is newer than what's included in Ubuntu 22.04, so on that Ubuntu version and older, you will have to install poetry via pipx.

Cheat Sheet

Setting Up for Local Dev

poetry install --with=linters --with=tests
poetry shell # This activates a virtual environment containing the dependencies

Running Linters and Formatter

poetry run mypy -p cy_serial_bridge
poetry run ruff check --fix .
poetry run ruff format .

Running Tests

poetry run pytest -v --capture=no --log-cli-level=INFO tests/

Note that this command has to be run with sudo on MacOS, see the README for details.

Uploading to PyPi

Pypy uploads will be generated automatically for releases tagged with a "vA.B.C" tag (e.g v0.1.0).