Data Stewardship Wizard Template Development Toolkit
Project description
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-url
not specified
- Used when
DSW_API_KEY
= API Key of the user authorized to manage document templates- Used when
--api-key
not 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
.env
file) - Verify the connection by issuing
dsw-tdk list
- Create a new template project
dsw-tdk new
or 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.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 details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dsw_tdk-4.8.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 453a31a1e010a89e4c5a364126126042677591b687faddb5b9392d9390eaad6a |
|
MD5 | 42236d834e9ae3b5092886c6007c089e |
|
BLAKE2b-256 | ed8359ecc87011e86e95cb789dec0772b5b52603d340663a151eb7af07e879ba |