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.8+
  • 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

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (4.34.0)

1 maintainer

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

Credits

Author: Marek Suchánek

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.33.0.tar.gz (25.7 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.33.0-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dsw_tdk-4.33.0.tar.gz
Algorithm Hash digest
SHA256 dd8fb807c380308d8b8337cca777434b762c79c6772568afd0104168ab1f311b
MD5 0c3bbc722f0c86fc05a1e9697e7cdf89
BLAKE2b-256 b7665dd5e6c917de41d79b80d5a39ebc3a628e1a799f6d3f8bbf91c296e11508

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for dsw_tdk-4.33.0-py3-none-any.whl
Algorithm Hash digest
SHA256 43ebbd3530ef75f8ca81dd81280e2f754419f00ea1deaee78545dc53c4c5efbf
MD5 6fcbc998fcd607344abfa455df6a0a07
BLAKE2b-256 02f8b8d7993dd4d4389bf15b29af04ffae5342c3f5af383e46e8939ce61a0739

See more details on using hashes here.

Release history Release notifications | RSS feed

4.34.0

2 files

This release

4.33.0 This release

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