Skip to content

README.dev.md

Latest commit

 

History

History
71 lines (57 loc) · 1.01 KB

README.dev.md

File metadata and controls

71 lines (57 loc) · 1.01 KB

Gateway - For Developers

  • Supported OS: Linux, macOS

Setup for Development

  1. Clone the repository
git clone https://app.git.valerii.cc/valerii/gateway.git
cd gateway
  1. Install uv
curl -LsSf https://astral.sh/uv/install.sh | sh
uv --version
  1. Install package & deps
uv venv
uv sync --dev
  1. Generate protobuf files
uv run scripts/gen_proto.py

Adding/ Removing packages

uv add requests --optional core
uv remove request --optional core

or adding to a group e.g., development

uv add requests --dev
uv remove requests --dev

Upgrading a version

  1. Bump up version in pyproject.toml
  2. Execute
git tag v0.1.4
git push origin v0.1.4

Tools for Development

Static Type Checker

uv run pyright

Testing

Run all the tests

uv run pytest

Show all testing markers

uv run pytest --markers | head -1

Run tests assigned to a marker

uv run pytest -m "marker"