Skip to main content

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

Project description

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

Some labs functionality may require extra dependencies - these can be installed by:

pip install destiny-sdk[labs]
uv add destiny-sdk --extra labs

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

destiny_sdk-0.7.2.tar.gz (98.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

destiny_sdk-0.7.2-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file destiny_sdk-0.7.2.tar.gz.

File metadata

  • Download URL: destiny_sdk-0.7.2.tar.gz
  • Upload date:
  • Size: 98.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.7.14

File hashes

Hashes for destiny_sdk-0.7.2.tar.gz
Algorithm Hash digest
SHA256 b22a2465e5e37ed0d683697040f802a41c35e01dd53093d8a46ff280d9a5150d
MD5 93289841be9692f0bcbe7703148f9cdf
BLAKE2b-256 1eed7fab60a1ea3713f067a520ee33e8b7f6519919490686acb0b502e4654476

See more details on using hashes here.

File details

Details for the file destiny_sdk-0.7.2-py3-none-any.whl.

File metadata

File hashes

Hashes for destiny_sdk-0.7.2-py3-none-any.whl
Algorithm Hash digest
SHA256 139816f24ff9f3c10b6db39bdeb10605a6f3caa210f93c7981bef760440948f2
MD5 37671c6efed72488e185b4b0b9a782e9
BLAKE2b-256 f6b266a872171eb636f2986ce83d86ebba7ae43aeffd01ff7937a6db8395e633

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page