Data Stewardship Wizard Template Development Toolkit
Project description
dsw-tdk
Template Development Kit for Data Stewardship Wizard
Installation
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.
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 of DSW API you want to use, e.g., https://api.demo.ds-wizard.org (notice that it is not the URL of client)- Used when
--api-server
not specified
- Used when
DSW_USERNAME
= username (email address) that you use to login with your admin account- Used when
--username
not specified
- Used when
DSW_PASSWORD
= corresponding password to login with your admin account- Used when
--password
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
Requirements
- Python 3.6+
- 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.
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.