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

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.4.1.tar.gz (48.3 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.4.1-py3-none-any.whl (23.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for destiny_sdk-0.4.1.tar.gz
Algorithm Hash digest
SHA256 78bda151f7b462c2b66ffba94075c006fa1b658e341581eb39972816b8f0bdd6
MD5 5d847a7be31d24b33ba6355c511776a0
BLAKE2b-256 5348eb25305c68fcfa214fe0698c46d93cbd2b1aa1f6ae6ea668005cf8ae993d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for destiny_sdk-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5ffb74149c89ffce1defa013f7b7320e24e67c481ec833cd020fecd88a7774ae
MD5 37a2462cea56689118804281cf878b74
BLAKE2b-256 0e0e2a6cde2b571370814d8aba68059df0773039a7abe724a968ddcd1170ea57

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