dsw-tdk
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 wizardlist= list templates available in configured DSW instanceget= download a template from DSW instanceput= upload a template to DSW instance (create or update)verify= check the metadata of local template projectpackage= 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-urlnot specified
- Used when
DSW_API_KEY= API Key of the user authorized to manage document templates- Used when
--api-keynot specified
- Used when
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
- Prepare your DSW instance and admin account (optionally, prepare
.envfile) - Verify the connection by issuing
dsw-tdk list - Create a new template project
dsw-tdk newor get existingdsw-tdk get(or re-use some local) - Go to the template project and make edits you need to do
- Update template in DSW with
dsw-tdk put(or continually withdsw-tdk put --watch) - (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.
1 maintainer
Metadata
1 maintainer
Release files for dsw-tdk 4.34.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| dsw_tdk-4.34.1.tar.gz | 25.6 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| dsw_tdk-4.34.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 56.6 kB
Release files / dsw_tdk-4.34.1.tar.gz
| Download URL | dsw_tdk-4.34.1.tar.gz |
|---|---|
| Size | 25.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d4bca259bcf380305e6ad6dc33c181e719ab592f980aace6eb97ed5a18759212
|
|
BLAKE2b-256 checksum How to use checksums |
f191520877814adaf739f7e1304e7b3e74540919b7f8099f9dbd0798b5202bd9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logRelease files / dsw_tdk-4.34.1-py3-none-any.whl
| Download URL | dsw_tdk-4.34.1-py3-none-any.whl |
|---|---|
| Size | 31.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0e34484f9fad0681e378c1519a1ac445a7a6e4477443d4651fd2a67fbf7970e5
|
|
BLAKE2b-256 checksum How to use checksums |
84ea0c65f4e2326f40ed60de83f4f346c8e9f18da9389405ed6e10f22a24cc9f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logSecurity for dsw-tdk 4.34.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for dsw_tdk-4.34.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Sep 13, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
