Skip to content

Commit 2fd4a07

Browse files
committed
Adjusts readme
1 parent eb2b8b7 commit 2fd4a07

File tree

3 files changed

+9
-35
lines changed

3 files changed

+9
-35
lines changed

scripts/generate-sdk/.openapi-generator-ignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ git_push.sh
22
.travis.yml
33
.gitignore
44
#utils.go
5-
README.md
5+
#README.md
66
response.go
77
api/openapi.yaml
88
.openapi-generator/*

templates/python/README.mustache

Lines changed: 7 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,58 +3,32 @@
33
{{{.}}}
44
{{/appDescriptionWithNewLines}}
55

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}}
156
{{#infoUrl}}
167
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
178
{{/infoUrl}}
189

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.
2011

21-
Python {{{generatorLanguageVersion}}}
2212

23-
## Installation & Usage
13+
## Installation and Usage
2414
### pip install
2515

26-
If the python package is hosted on a repository, you can install directly using:
27-
2816
```sh
29-
pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
17+
pip install {{{pythonPackageName}}}
3018
```
31-
(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
3219

3320
Then import the package:
3421
```python
3522
import {{{packageName}}}
3623
```
3724

38-
### Setuptools
25+
## Getting Started
3926

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.
4128

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:
4630

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 }}
5532

56-
## Getting Started
5733

58-
Please follow the [installation procedure](#installation--usage) and then run the following:
5934

60-
{{> common_README }}

templates/python/pyproject.mustache

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ authors = [
55
"{{infoName}}{{^infoName}}OpenAPI Generator Community{{/infoName}} <{{infoEmail}}{{^infoEmail}}[email protected]{{/infoEmail}}>",
66
]
77
description = "{{{appName}}}"
8-
#readme = "README.md"
8+
readme = "README.md"
99
#license = "{{{licenseInfo}}}{{^licenseInfo}}NoLicense{{/licenseInfo}}"
1010
classifiers = [
1111
"Programming Language :: Python :: 3",

0 commit comments

Comments
 (0)