1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
|
%global _empty_manifest_terminate_build 0
Name: python-dsw-tdk
Version: 3.24.0
Release: 1
Summary: Data Stewardship Wizard Template Development Toolkit
License: Apache License 2.0
URL: https://ds-wizard.org
Source0: https://mirrors.aliyun.com/pypi/web/packages/49/d9/27dbda6af7172050113f7a2deabf8242b4595faefc9a0572b59a4e236a93/dsw-tdk-3.24.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.24.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
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 3.24.0-1
- Package Spec generated
|
