github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/README.mustache (about) 1 # {{{projectName}}} 2 3 Phrase Strings is a translation management platform for software projects. You can collaborate on language file translation with your team or order translations through our platform. The API allows you to import locale files, download locale files, tag keys or interact in other ways with the localization data stored in Phrase Strings for your account. 4 5 This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: 6 7 - API version: {{appVersion}} 8 - Package version: {{packageVersion}} 9 {{^hideGenerationTimestamp}} 10 - Build date: {{generatedDate}} 11 {{/hideGenerationTimestamp}} 12 - Build package: {{generatorClass}} 13 {{#infoUrl}} 14 For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}}) 15 {{/infoUrl}} 16 17 ## Requirements. 18 19 Python 2.7 and 3.4+ 20 21 ## Installation & Usage 22 ### pip install 23 24 ```sh 25 pip install phrase-api 26 ``` 27 28 Then import the package: 29 ```python 30 import {{{packageName}}} 31 ``` 32 33 ### pip install from Github repository 34 35 If the python package is hosted on a repository, you can install directly using: 36 37 ```sh 38 pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git 39 ``` 40 (you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`) 41 42 Then import the package: 43 ```python 44 import {{{packageName}}} 45 ``` 46 47 ### Setuptools 48 49 Install via [Setuptools](http://pypi.python.org/pypi/setuptools). 50 51 ```sh 52 python setup.py install --user 53 ``` 54 (or `sudo python setup.py install` to install the package for all users) 55 56 Then import the package: 57 ```python 58 import {{{packageName}}} 59 ``` 60 61 ## Getting Started 62 63 Please follow the [installation procedure](#installation--usage) and then run the following: 64 65 {{> common_README }}