You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
|
|
3 years ago | |
|---|---|---|
| .. | ||
| model_templates | 4 years ago | |
| .openapi-generator-ignore | 4 years ago | |
| README.mustache | 3 years ago | |
| README_common.mustache | 3 years ago | |
| __init__.mustache | 4 years ago | |
| __init__api.mustache | 4 years ago | |
| __init__apis.mustache | 4 years ago | |
| __init__model.mustache | 4 years ago | |
| __init__models.mustache | 4 years ago | |
| __init__package.mustache | 4 years ago | |
| api.mustache | 4 years ago | |
| api_client.mustache | 4 years ago | |
| api_name.mustache | 4 years ago | |
| configuration.mustache | 4 years ago | |
| model.mustache | 4 years ago | |
| model_utils.mustache | 4 years ago | |
| operation_name.mustache | 4 years ago | |
| partial_header.mustache | 4 years ago | |
| rest.mustache | 4 years ago | |
| return_type.mustache | 4 years ago | |
| setup.mustache | 4 years ago | |
README.mustache
# {{{projectName}}}
{{#appDescriptionWithNewLines}}
{{{.}}}
{{/appDescriptionWithNewLines}}
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: {{appVersion}}
- Package version: {{packageVersion}}
{{^hideGenerationTimestamp}}
- Build date: {{generatedDate}}
{{/hideGenerationTimestamp}}
- Build package: {{generatorClass}}
{{#infoUrl}}
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
{{/infoUrl}}
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
Then import the package:
```python
import {{{packageName}}}
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import {{{packageName}}}
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
{{> README_common }}