README.mustache 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  1. # Python API client for {{appName}}
  2. This Python package is automatically generated from [PeerTube's REST API](https://docs.joinpeertube.org/api-rest-reference.html),
  3. using the [OpenAPI Generator](https://openapi-generator.tech) project:
  4. - API version: {{appVersion}}
  5. - Package version: {{packageVersion}}
  6. {{^hideGenerationTimestamp}}
  7. - Build date: {{generatedDate}}
  8. {{/hideGenerationTimestamp}}
  9. - Build package: {{generatorClass}}
  10. {{#infoUrl}}
  11. For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
  12. {{/infoUrl}}
  13. ## Requirements.
  14. Python 2.7 and 3.4+
  15. ## Installation & Usage
  16. ```sh
  17. pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git
  18. ```
  19. (you may need to run `pip` with root permission: `sudo pip install git+https://{{gitHost}}/{{{gitUserId}}}/{{{gitRepoId}}}.git`)
  20. Then import the package:
  21. ```python
  22. import {{{packageName}}}
  23. ```
  24. ## Getting Started
  25. Please follow the [installation procedure](#installation--usage) and then run the following:
  26. {{> common_README }}
  27. ## License
  28. Copyright (C) 2015-2020 PeerTube Contributors
  29. 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.
  30. 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.
  31. 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.