destiny_sdk 0.5.0

A software development kit (sdk) to support interaction with the DESTINY repository

DESTINY SDK

SDK for interaction with the DESTINY repository. For now this just contains data models for validation and structuring, but will be built out to include convenience functions etc.

Documentation

The documentation for destiny-sdk is hosted here

Installation from PyPI

pip install destiny-sdk

uv add destiny-sdk

Development

Dependencies

uv install

Tests

uv run pytest

Installing as an editable package of another project

Run the following command in the root folder of the other project (assuming uv as a packaging framework). Pip also has an --editable option that you can use.

uv add --editable ./PATH/TO/sdk/

or replace the dependency in pyproject.toml with

destiny-sdk = {path = "./PATH/TO/sdk/", develop = true}

Installing a local wheel

If you want to use a local build of the sdk z.whl, do

uv build
uv add ./PATH/TO/WHEEL.whl

Publishing

Once the package change is merged to main with an iterated libs/sdk/pyproject.toml version number, you can run the github action to publish to the test pypi and then production pypi registries.

Versioning

Follow the semver guidelines for versioning, tldr;

Given a version number MAJOR.MINOR.PATCH, increment the:

• MAJOR version when you make incompatible API change
• MINOR version when you add functionality in a backward compatible manner
• PATCH version when you make backward compatible bug fixes