10Duke Scale SDK for Python

The 10Duke Scale SDK for Python is a library to facilitate building applications licensed using 10Duke Scale.

Contents

• Why?
• Getting started
• Development
• Getting involved
• Resources
• License

Why

Providing a set of Python client bindings for the 10Duke Scale REST API and a set of helper classes to configure the SDK, authenticate users, and provide authorization for API requests enables software vendors to focus on their software and their application domain. The SDK makes using 10Duke Scale in an application simpler and allows faster adoption.

Getting Started

The code is tested on Python versions 3.10, 3.11, 3.12, and 3.13.

Installation

Using pip

pip install tenduke_scale

Using poetry

poetry add tenduke_scale

Documentation

The user guide and API documentation are here.

Development

To get started with working on the code, clone this repository.

git clone git@gitlab.com:10Duke/scale/python/python-scale-sdk.git

Then you need to install the tools and dependencies.

Install poetry:

curl -sSL https://install.python-poetry.org | python3

Start the virtual environment for the project:

poetry env activate

Resolve dependencies:

poetry lock

Install dependencies:

poetry install

The tests can be run using

poetry run pytest .

For linux or macOS, a Makefile is provided to automate these, and other, development tasks.

Code formatting / linting

This project is using:

• ruff for linting and code formatting
• markdownlint for linting markdown.

Bumping version and releasing

The project is using Semantic Versioning.

The version shall be set using poetry version. This will update the version number in pyproject.toml.

That change shall be committed in a new revision.

That revision shall be tagged (for example git tag v1.1.1).

The new tag shall be pushed (git push --tags).

That will trigger the creation of a new package and the publishing of that package to the relevant repository.

Publishing to PyPi requires additional steps.

Getting involved

We welcome contributions! Contributing explains what kind of contributions we welcome.

10Duke specific dependencies

The project depends on tenduke-core/10Duke Python core library package. If you are making changes that affect both tenduke-core and this project, there is some additional documentation on suggested workflow.

Resources

• 10Duke Scale documentation
• 10Duke.com - Find more information about 10Duke products and services

License

10Duke Scale SDK for Python is licensed under the MIT license.