|
3 | 3 | {{{.}}} |
4 | 4 | {{/appDescriptionWithNewLines}} |
5 | 5 |
|
6 | | -This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: |
7 | | - |
8 | | -- API version: {{appVersion}} |
9 | | -- Package version: {{packageVersion}} |
10 | | -{{^hideGenerationTimestamp}} |
11 | | -- Build date: {{generatedDate}} |
12 | | -{{/hideGenerationTimestamp}} |
13 | | -- Generator version: {{generatorVersion}} |
14 | | -- Build package: {{generatorClass}} |
15 | 6 | {{#infoUrl}} |
16 | 7 | For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) |
17 | 8 | {{/infoUrl}} |
18 | 9 |
|
19 | | -## Requirements. |
| 10 | +This package is part of the STACKIT Python SDK. For more detailed information please visit the [github repository](https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}) of the SDK. |
20 | 11 |
|
21 | | -Python {{{generatorLanguageVersion}}} |
22 | 12 |
|
23 | | -## Installation & Usage |
| 13 | +## Installation and Usage |
24 | 14 | ### pip install |
25 | 15 |
|
26 | | -If the python package is hosted on a repository, you can install directly using: |
27 | | - |
28 | 16 | ```sh |
29 | | -pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git |
| 17 | +pip install {{{pythonPackageName}}} |
30 | 18 | ``` |
31 | | -(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`) |
32 | 19 |
|
33 | 20 | Then import the package: |
34 | 21 | ```python |
35 | 22 | import {{{packageName}}} |
36 | 23 | ``` |
37 | 24 |
|
38 | | -### Setuptools |
| 25 | +## Getting Started |
39 | 26 |
|
40 | | -Install via [Setuptools](http://pypi.python.org/pypi/setuptools). |
| 27 | +[Examples](https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}/tree/main/examples) for the usage of the package can be found in the [github repository](https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}) of the SDK. |
41 | 28 |
|
42 | | -```sh |
43 | | -python setup.py install --user |
44 | | -``` |
45 | | -(or `sudo python setup.py install` to install the package for all users) |
| 29 | +Please follow the [installation procedure](#installation-and-usage) and then run the following: |
46 | 30 |
|
47 | | -Then import the package: |
48 | | -```python |
49 | | -import {{{packageName}}} |
50 | | -``` |
51 | | - |
52 | | -### Tests |
53 | | - |
54 | | -Execute `pytest` to run the tests. |
| 31 | +{{> common_README }} |
55 | 32 |
|
56 | | -## Getting Started |
57 | 33 |
|
58 | | -Please follow the [installation procedure](#installation--usage) and then run the following: |
59 | 34 |
|
60 | | -{{> common_README }} |
0 commit comments