github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/python-experimental/README.mustache (about) 1 # {{{projectName}}} 2 {{#appDescriptionWithNewLines}} 3 {{{appDescriptionWithNewLines}}} 4 {{/appDescriptionWithNewLines}} 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 - Build package: {{generatorClass}} 14 {{#infoUrl}} 15 For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) 16 {{/infoUrl}} 17 18 ## Requirements. 19 20 Python 2.7 and 3.4+ 21 22 ## Installation & Usage 23 ### pip install 24 25 If the python package is hosted on a repository, you can install directly using: 26 27 ```sh 28 pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git 29 ``` 30 (you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`) 31 32 Then import the package: 33 ```python 34 import {{{packageName}}} 35 ``` 36 37 ### Setuptools 38 39 Install via [Setuptools](http://pypi.python.org/pypi/setuptools). 40 41 ```sh 42 python setup.py install --user 43 ``` 44 (or `sudo python setup.py install` to install the package for all users) 45 46 Then import the package: 47 ```python 48 import {{{packageName}}} 49 ``` 50 51 ## Getting Started 52 53 Please follow the [installation procedure](#installation--usage) and then run the following: 54 55 {{> python-experimental/README_common }}