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.4.tar.gz (99.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.7.4-py3-none-any.whl (32.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for destiny_sdk-0.7.4.tar.gz
Algorithm Hash digest
SHA256 4df3643700969f36525dee084f77ebf48a90f5fbe728cd1b0e04cb79535e2ce6
MD5 e68e5f03db04405304fc2f8bf3b80a1c
BLAKE2b-256 61eef1acd0c3fd354c346f24f6c83542a64280e14aa518e3eb3ed1fbf9975343

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for destiny_sdk-0.7.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8ea46ad2bdbc5b9c730d1307d34e3aaa0eefc4875c27021f70ba386d77712cfb
MD5 2a7bd6a3914897c71aa3f261ecfbe8ab
BLAKE2b-256 62803134416a687c4b35938d7d96bb12281d73a1373610cc7b86a2e9a7246e1c

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