Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
63 lines (39 loc) · 1.29 KB

DEVELOPMENT.md

File metadata and controls

63 lines (39 loc) · 1.29 KB
Raw

Development

Async and non-async

A forked version of Unasync is used to generate non-async code based on the async implementation. Only make changes to files in src/cerbos/sdk/_async. Then run ./pw generate to re-generate the code in src/cerbos/sdk/_sync.

Package management

This project uses PDM with Pyprojectx for package management. The pw script should be used when working with this project.

Adding a new dependency

./pw pdm add dataclasses-json

Adding a tool

# Add Ruff to tool group
./pw pdm add -dG tools ruff

Formatting code

./pw format

Running tests

./pw test

Running a REPL

./pw pdm run python

Testing with Podman

TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE="unix://${XDG_RUNTIME_DIR}/podman/podman.sock" TESTCONTAINERS_RYUK_DISABLED=true ./pw test

Releases

  • Run ./pw tag_release PATCH to generate the changelog and tag the release. (Replace PATCH with MINOR if you are incrementing the minor version.)
  • Push the new tag to GitHub to launch the CI release job

Publishing to Test PyPI

./pw pdm build

# Test PyPI
./pw twine upload -r testpypi dist/*