dsw-tdk

User Guide GitHub release (latest SemVer) PyPI Docker Pulls LICENSE CII Best Practices Python Version

Template Development Kit for Data Stewardship Wizard

Installation

Python package

You can easily install this tool using pip (from PyPI):

$ pip install dsw-tdk

Optionally, you can clone any version from this repository and install it directly:

$ git clone https://github.com/ds-wizard/dsw-tdk.git
$ pip install -e .

We recommend using virtual environments to avoid clashes in dependencies with other projects.

Dockerized tool

If you don't want to use Python directly on your machine, you can easily use Docker image with DSW TDK:

$ docker run datastewardshipwizard/dsw-tdk --help
$ docker run datastewardshipwizard/dsw-tdk:develop --help

See datastewardshipwizard/dsw-tdk on Docker Hub to check available tags.

Usage

You can find out possibilities directly using --help flag:

$ dsw-tdk --help
$ dsw-tdk put --help

For further information, visit our documentation.

Basic commands

  • new = create a new template project locally using interactive wizard
  • list = list templates available in configured DSW instance
  • get = download a template from DSW instance
  • put = upload a template to DSW instance (create or update)
  • verify = check the metadata of local template project
  • package = create a distribution ZIP package that is importable to DSW via web interface

Environment variables

You can use the following environment variables to avoid repeating CLI options.

  • DSW_API_URL = URL of DSW API you want to use, e.g., https://api.demo.ds-wizard.org (notice that it is not the URL of client, you can find it out by clicking Help > About in DSW)
    • Used when --api-url not specified
  • DSW_API_KEY = API Key of the user authorized to manage document templates
    • Used when --api-key not specified

You can also use them in .env file which is automatically loaded from current directory or specify it using --dot-env option:

$ ls -a
. .. .env my-other-file
$ dsw-tdk list
$ dsw-tdk --dot-env /path/to/my/.env list

How to start

  1. Prepare your DSW instance and admin account (optionally, prepare .env file)
  2. Verify the connection by issuing dsw-tdk list
  3. Create a new template project dsw-tdk new or get existing dsw-tdk get (or re-use some local)
  4. Go to the template project and make edits you need to do
  5. Update template in DSW with dsw-tdk put (or continually with dsw-tdk put --watch)
  6. (or) Create a distribution ZIP package that is importable via DSW web interface with dsw-tdk package

Verbosity

You can use --quiet and --debug flags to toggle less or more output messages:

$ dsw-tdk --quiet list
$ dsw-tdk --debug list

Requirements

  • Python 3.12+
  • DSW instance with matching version (e.g. a local one using Docker)
  • Admin credentials (email+password) to the DSW instance

Contributing

We welcome any form of feedback and contribution to this tool:

  • Report bugs or ask in case of uncertainty using GitHub Issues.
  • Share ideas and feature requests using DSW Ideas site.
  • Submit enhancements using Pull Requests, just please make sure that you comply with used conventions.

For more information read CONTRIBUTING.

License

This project is licensed under the Apache 2 License - see the LICENSE file for more details.

Project links

Data verified by PyPI on Sep 1, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for mareksuchanek from gravatar.com mareksuchanek

Credits

Author: Marek Suchánek

GitHub Statistics

Data verified by PyPI on Sep 1, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

Apache Software License (Apache License 2.0)

Requires

Python <4, >=3.12

Provides Extra

test

Tags

documents dsw jinja2 template toolkit

Classifiers

Report project as malware

Download files

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

Source Distribution

dsw_tdk-4.34.0.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

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

dsw_tdk-4.34.0-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

Details for the file dsw_tdk-4.34.0.tar.gz.

File metadata

  • Download URL: dsw_tdk-4.34.0.tar.gz
  • Upload date:
  • Size: 25.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dsw_tdk-4.34.0.tar.gz
Algorithm Hash digest
SHA256 aab869b9632b8ffa4921fb88a50ac8815cc14c0238062f2e18f903c951e8776a
MD5 3a55480747d738c81631b525badf1d37
BLAKE2b-256 69360418cba0b2b39bedce446284e0a2ab30f550f9cafa913599fb81d30dcd47

See more details on using hashes here.

Provenance

The following attestation bundles were made for dsw_tdk-4.34.0.tar.gz:

Publisher: release-package.yml on ds-wizard/engine-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dsw_tdk-4.34.0-py3-none-any.whl.

File metadata

  • Download URL: dsw_tdk-4.34.0-py3-none-any.whl
  • Upload date:
  • Size: 31.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for dsw_tdk-4.34.0-py3-none-any.whl
Algorithm Hash digest
SHA256 642eb9f21cabc6235467e9e7c6bcc7d64b97862e39eb8dc6852960f6822dc66d
MD5 888a2dc118ac53561eb300ab7ed6e3b5
BLAKE2b-256 6bb1e1f22e1996b61df9f595d9bc683d64de179ec656e4cbdfc56da2d0f24030

See more details on using hashes here.

Provenance

The following attestation bundles were made for dsw_tdk-4.34.0-py3-none-any.whl:

Publisher: release-package.yml on ds-wizard/engine-tools

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.34.0 This release

2 files

4.33.0

2 files

4.32.0

2 files

4.31.0

2 files

4.30.2

2 files

4.30.1

2 files

4.30.0

2 files

4.29.2

2 files

4.29.1

2 files

4.29.0

2 files

4.28.4

2 files

4.28.3

2 files

4.28.2

2 files

4.28.1

2 files

4.28.0

2 files

4.27.1

2 files

4.27.0

2 files

4.26.1

2 files

4.26.0

2 files

Pre-release

4.26.0rc1

2 files

4.25.1

2 files

4.25.0

2 files

4.24.0

2 files

4.23.2

2 files

4.23.1

2 files

4.23.0

2 files

4.22.6

2 files

4.22.5

2 files

4.22.4

2 files

4.22.3

2 files

4.22.2

2 files

4.22.1

2 files

4.22.0

2 files

4.21.1

2 files

4.21.0

2 files

4.20.1

2 files

4.20.0

2 files

4.19.2

2 files

4.19.1

2 files

4.19.0

2 files

4.18.4

2 files

4.18.3

2 files

4.18.2

2 files

4.18.1

2 files

4.18.0

2 files

4.17.0

2 files

4.16.0

2 files

4.15.0

2 files

4.14.0

2 files

4.13.0

2 files

4.12.0

2 files

4.11.0

2 files

4.10.6

2 files

4.10.5

2 files

4.10.4

2 files

4.10.3

2 files

4.10.2

2 files

4.10.1

2 files

4.10.0

2 files

4.9.6

2 files

4.9.5

2 files

4.9.4

2 files

4.9.3

2 files

4.9.2

2 files

4.9.1

2 files

4.9.0

2 files

4.8.2

2 files

4.8.1

2 files

4.8.0

2 files

4.7.0

2 files

4.6.0

2 files

4.5.0

2 files

4.4.1

2 files

4.4.0

2 files

4.3.2

2 files

4.3.1

2 files

4.3.0

2 files

4.2.1

2 files

4.2.0

2 files

4.1.2

2 files

4.1.1

2 files

4.1.0

2 files

4.0.1

2 files

4.0.0

2 files

Pre-release

4.0.0rc2

2 files

3.28.0

2 files

3.27.1

2 files

3.27.0

2 files

3.26.2

2 files

3.26.1

2 files

3.26.0

2 files

3.25.1

2 files

3.25.0

2 files

3.24.0

2 files

Pre-release

3.24.0rc1

2 files

3.23.0

2 files

3.22.1

2 files

3.22.0

2 files

3.21.0

2 files

3.20.2

2 files

3.20.1

2 files

3.20.0

2 files

3.19.2

2 files

3.19.1

2 files

3.19.0

2 files

3.18.0

2 files

3.17.0

2 files

3.16.0

2 files

3.15.3

2 files

3.15.2

2 files

3.15.1

2 files

3.15.0

2 files

3.14.1

2 files

3.14.0

2 files

Pre-release

3.14.0rc1

2 files

3.13.0

2 files

3.12.0

2 files

3.11.0

2 files

3.10.0

2 files

3.9.0

2 files

3.8.0

2 files

3.7.0

2 files

3.6.0

2 files

3.5.2

2 files

3.5.1

2 files

3.5.0

2 files

3.4.0

2 files

3.3.0

2 files

3.2.1

2 files

3.2.0

2 files

3.1.0

2 files

3.0.0

2 files

2.14.0

2 files

2.13.0

2 files

2.12.1

2 files

2.12.0

2 files

2.11.0

2 files

2.10.0

2 files

2.9.0

2 files

2.8.1

2 files

2.8.0

2 files

Pre-release

2.8.0rc1

2 files

Pre-release

2.7.0a1

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page