support/openapi/python/README.mustache

   1 # Python API client for {{appName}}
   2
   3 This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
   4 using the [OpenAPI Generator](https://openapi-generator.tech) project:
   5
   6 - API version: {{appVersion}}
   7 - Package version: {{packageVersion}}
   8 {{^hideGenerationTimestamp}}
   9 - Build date: {{generatedDate}}
  10 {{/hideGenerationTimestamp}}
  11 - Build package: {{generatorClass}}
  12
  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
  23 ```sh
  24 pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
  25 ```
  26 (you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
  27
  28 Then import the package:
  29 ```python
  30 import {{{packageName}}}
  31 ```
  32
  33 ## Getting Started
  34
  35 Please follow the [installation procedure](#installation--usage) and then run the following:
  36
  37 {{> common_README }}
  38
  39 ## License
  40
  41 Copyright (C) 2015-2020 PeerTube Contributors
  42
  43 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  44
  45 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.
  46
  47 You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses.