diff options
author | CoprDistGit <infra@openeuler.org> | 2023-05-31 03:52:58 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-05-31 03:52:58 +0000 |
commit | db77ea889b1a398512830ec178a33f1081a0731a (patch) | |
tree | d71376a8e1982fb468e3e3f31f46ea2f29d8f553 | |
parent | a95e64c3453f0bff29587afe3ad82eccaf9d04fb (diff) |
automatic import of python-dsw-tdk
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-dsw-tdk.spec | 440 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 442 insertions, 0 deletions
@@ -0,0 +1 @@ +/dsw-tdk-3.23.0.tar.gz diff --git a/python-dsw-tdk.spec b/python-dsw-tdk.spec new file mode 100644 index 0000000..1ac1342 --- /dev/null +++ b/python-dsw-tdk.spec @@ -0,0 +1,440 @@ +%global _empty_manifest_terminate_build 0 +Name: python-dsw-tdk +Version: 3.23.0 +Release: 1 +Summary: Data Stewardship Wizard Template Development Toolkit +License: Apache License 2.0 +URL: https://ds-wizard.org +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/d8/f9/5f1e81859268324942292d64cc66fde8c239a4bc925a9afd6b67b4a235c8/dsw-tdk-3.23.0.tar.gz +BuildArch: noarch + +Requires: python3-aiohttp +Requires: python3-click +Requires: python3-colorama +Requires: python3-humanize +Requires: python3-Jinja2 +Requires: python3-multidict +Requires: python3-pathspec +Requires: python3-dotenv +Requires: python3-slugify +Requires: python3-watchgod +Requires: python3-pytest + +%description +# 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 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-server` not specified +- `DSW_USERNAME` = username (email address) that you use to login with your admin account + - Used when `--username` not specified +- `DSW_PASSWORD` = corresponding password to login with your admin account + - Used when `--password` 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. + + +%package -n python3-dsw-tdk +Summary: Data Stewardship Wizard Template Development Toolkit +Provides: python-dsw-tdk +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-dsw-tdk +# 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 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-server` not specified +- `DSW_USERNAME` = username (email address) that you use to login with your admin account + - Used when `--username` not specified +- `DSW_PASSWORD` = corresponding password to login with your admin account + - Used when `--password` 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. + + +%package help +Summary: Development documents and examples for dsw-tdk +Provides: python3-dsw-tdk-doc +%description help +# 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 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-server` not specified +- `DSW_USERNAME` = username (email address) that you use to login with your admin account + - Used when `--username` not specified +- `DSW_PASSWORD` = corresponding password to login with your admin account + - Used when `--password` 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. + + +%prep +%autosetup -n dsw-tdk-3.23.0 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-dsw-tdk -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed May 31 2023 Python_Bot <Python_Bot@openeuler.org> - 3.23.0-1 +- Package Spec generated @@ -0,0 +1 @@ +125109b75807b13db35ea5a17bfff515 dsw-tdk-3.23.0.tar.gz |