Template Development Kit for Data Stewardship Wizard
:bangbang: This project has been moved to monorepo ds-wizard/engine-tools :bangbang:
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.
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.
You can find out possibilities directly using --help
flag:
$ dsw-tdk --help
$ dsw-tdk put --help
For further information, visit our documentation.
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 interfaceYou can use the following environment variables to avoid repeating CLI options.
DSW_API
= 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)
--api-server
not specifiedDSW_USERNAME
= username (email address) that you use to login with your admin account
--username
not specifiedDSW_PASSWORD
= corresponding password to login with your admin account
--password
not specifiedYou 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
.env
file)dsw-tdk list
dsw-tdk new
or get existing dsw-tdk get
(or re-use some local)dsw-tdk put
(or continually with dsw-tdk put --watch
)dsw-tdk package
You can use --quiet
and --debug
flags to toggle less or more output messages:
$ dsw-tdk --quiet list
$ dsw-tdk --debug list
We welcome any form of feedback and contribution to this tool:
For more information read CONTRIBUTING.
This project is licensed under the Apache 2 License - see the LICENSE file for more details.