# dsw-tdk
[](https://guide.ds-wizard.org)
[](https://github.com/ds-wizard/engine-tools/releases)
[](https://pypi.org/project/dsw-tdk/)
[](https://hub.docker.com/r/datastewardshipwizard/dsw-tdk)
[](LICENSE)
[](https://bestpractices.coreinfrastructure.org/projects/4975)
[](https://python.org)
*Template Development Kit for [Data Stewardship Wizard](https://ds-wizard.org)*
## Installation
### Python package
You can easily install this tool using [pip](https://pip.pypa.io/en/stable/) (from [PyPI](https://pypi.org/project/dsw-tdk/)):
```shell script
$ pip install dsw-tdk
```
Optionally, you can clone any version from this repository and install it directly:
```shell script
$ git clone https://github.com/ds-wizard/dsw-tdk.git
$ pip install -e .
```
We recommend using [virtual environments](https://docs.python.org/3/library/venv.html) 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](https://hub.docker.com/repository/docker/datastewardshipwizard/dsw-tdk) to check available tags.
## Usage
You can find out possibilities directly using `--help` flag:
```shell script
$ dsw-tdk --help
$ dsw-tdk put --help
```
For further information, visit our [documentation](https://docs.ds-wizard.org).
### 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:
```shell script
$ 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:
```shell script
$ dsw-tdk --quiet list
$ dsw-tdk --debug list
```
## Requirements
- [Python 3.8+](https://www.python.org/downloads/)
- DSW instance with matching version (e.g. a local one using [Docker](https://github.com/ds-wizard/dsw-deployment-example))
- 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](https://github.com/ds-wizard/dsw-tdk/issues).
- Share ideas and feature requests using [DSW Ideas site](https://ideas.ds-wizard.org).
- Submit enhancements using [Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests), just please make sure that you comply with used conventions.
For more information read [CONTRIBUTING](CONTRIBUTING.md).
## License
This project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for more details.
Raw data
{
"_id": null,
"home_page": null,
"name": "dsw-tdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9",
"maintainer_email": null,
"keywords": "documents, dsw, jinja2, template, toolkit",
"author": null,
"author_email": "Marek Such\u00e1nek <marek.suchanek@ds-wizard.org>",
"download_url": "https://files.pythonhosted.org/packages/b0/fa/2cf6cc723eb34783163d8479f05eef462bb62c46860472491299e41ffb51/dsw-tdk-4.5.0.tar.gz",
"platform": null,
"description": "# dsw-tdk\n\n[](https://guide.ds-wizard.org)\n[](https://github.com/ds-wizard/engine-tools/releases)\n[](https://pypi.org/project/dsw-tdk/)\n[](https://hub.docker.com/r/datastewardshipwizard/dsw-tdk)\n[](LICENSE)\n[](https://bestpractices.coreinfrastructure.org/projects/4975)\n[](https://python.org)\n\n*Template Development Kit for [Data Stewardship Wizard](https://ds-wizard.org)*\n\n## Installation\n\n### Python package\n\nYou can easily install this tool using [pip](https://pip.pypa.io/en/stable/) (from [PyPI](https://pypi.org/project/dsw-tdk/)):\n\n```shell script\n$ pip install dsw-tdk\n```\n\nOptionally, you can clone any version from this repository and install it directly:\n\n```shell script\n$ git clone https://github.com/ds-wizard/dsw-tdk.git\n$ pip install -e .\n```\n\nWe recommend using [virtual environments](https://docs.python.org/3/library/venv.html) to avoid clashes in dependencies with other projects.\n\n### Dockerized tool\n\nIf you don't want to use Python directly on your machine, you can easily use Docker image with DSW TDK:\n\n```\n$ docker run datastewardshipwizard/dsw-tdk --help\n$ docker run datastewardshipwizard/dsw-tdk:develop --help\n```\n\nSee [datastewardshipwizard/dsw-tdk on Docker Hub](https://hub.docker.com/repository/docker/datastewardshipwizard/dsw-tdk) to check available tags.\n\n## Usage\n\nYou can find out possibilities directly using `--help` flag:\n\n```shell script\n$ dsw-tdk --help\n$ dsw-tdk put --help\n```\n\nFor further information, visit our [documentation](https://docs.ds-wizard.org).\n\n### Basic commands\n\n- `new` = create a new template project locally using interactive wizard\n- `list` = list templates available in configured DSW instance\n- `get` = download a template from DSW instance\n- `put` = upload a template to DSW instance (create or update)\n- `verify` = check the metadata of local template project\n- `package` = create a distribution ZIP package that is importable to DSW via web interface\n\n### Environment variables\n\nYou can use the following environment variables to avoid repeating CLI options.\n\n- `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)\n - Used when `--api-url` not specified\n- `DSW_API_KEY` = API Key of the user authorized to manage document templates\n - Used when `--api-key` not specified\n \n You can also use them in `.env` file which is automatically loaded from current directory or specify it using `--dot-env` option:\n \n```shell script\n$ ls -a\n. .. .env my-other-file\n$ dsw-tdk list\n$ dsw-tdk --dot-env /path/to/my/.env list\n```\n \n### How to start\n\n1. Prepare your DSW instance and admin account (optionally, prepare `.env` file)\n2. Verify the connection by issuing `dsw-tdk list`\n3. Create a new template project `dsw-tdk new` or get existing `dsw-tdk get` (or re-use some local)\n4. Go to the template project and make edits you need to do\n5. Update template in DSW with `dsw-tdk put` (or continually with `dsw-tdk put --watch`)\n6. (or) Create a distribution ZIP package that is importable via DSW web interface with `dsw-tdk package`\n\n### Verbosity\n\nYou can use `--quiet` and `--debug` flags to toggle less or more output messages:\n\n```shell script\n$ dsw-tdk --quiet list\n$ dsw-tdk --debug list\n```\n\n## Requirements\n\n- [Python 3.8+](https://www.python.org/downloads/)\n- DSW instance with matching version (e.g. a local one using [Docker](https://github.com/ds-wizard/dsw-deployment-example))\n- Admin credentials (email+password) to the DSW instance\n\n## Contributing\n\nWe welcome any form of feedback and contribution to this tool:\n\n- Report bugs or ask in case of uncertainty using [GitHub Issues](https://github.com/ds-wizard/dsw-tdk/issues).\n- Share ideas and feature requests using [DSW Ideas site](https://ideas.ds-wizard.org).\n- Submit enhancements using [Pull Requests](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests), just please make sure that you comply with used conventions.\n\nFor more information read [CONTRIBUTING](CONTRIBUTING.md).\n\n## License\n\nThis project is licensed under the Apache 2 License - see the [LICENSE](LICENSE) file for more details.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Data Stewardship Wizard Template Development Toolkit",
"version": "4.5.0",
"project_urls": {
"Documentation": "https://guide.ds-wizard.org",
"Homepage": "https://ds-wizard.org",
"Repository": "https://github.com/ds-wizard/engine-tools"
},
"split_keywords": [
"documents",
" dsw",
" jinja2",
" template",
" toolkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bdfaf09c173597f54a9339d1cbd8a55b5e0613b3657e7111b89bfff003f1d3e2",
"md5": "a504a13ccb924e4c3aacb4fe9c060f0e",
"sha256": "6310e5770d9c4b1b3f0c9a7084f35e6c792d1be1b504fb38bc89c70c8f04a292"
},
"downloads": -1,
"filename": "dsw_tdk-4.5.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "a504a13ccb924e4c3aacb4fe9c060f0e",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": "<4,>=3.9",
"size": 30778,
"upload_time": "2024-04-02T10:29:24",
"upload_time_iso_8601": "2024-04-02T10:29:24.724134Z",
"url": "https://files.pythonhosted.org/packages/bd/fa/f09c173597f54a9339d1cbd8a55b5e0613b3657e7111b89bfff003f1d3e2/dsw_tdk-4.5.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b0fa2cf6cc723eb34783163d8479f05eef462bb62c46860472491299e41ffb51",
"md5": "52640a3df614662cd2053be2a59fa21e",
"sha256": "5b849400c126f3e7d48c490935a7b60e67fbc4d31c1e513fcf19f9aedc4f665b"
},
"downloads": -1,
"filename": "dsw-tdk-4.5.0.tar.gz",
"has_sig": false,
"md5_digest": "52640a3df614662cd2053be2a59fa21e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9",
"size": 33509,
"upload_time": "2024-04-02T10:29:27",
"upload_time_iso_8601": "2024-04-02T10:29:27.130614Z",
"url": "https://files.pythonhosted.org/packages/b0/fa/2cf6cc723eb34783163d8479f05eef462bb62c46860472491299e41ffb51/dsw-tdk-4.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 10:29:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ds-wizard",
"github_project": "engine-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "dsw-tdk"
}
JSON
