openai/openai-python
Publicmirrored from https://github.com/openai/openai-pythonAvailable
README.md
43lines · modeblame
3c6d4cd6Greg Brockman5 years ago | 1 | # OpenAI Python Library |
| 2 | | |
| 3 | The OpenAI Python library provides convenient access to the OpenAI API | |
| 4 | from applications written in the Python language. It includes a | |
| 5 | pre-defined set of classes for API resources that initialize | |
| 6 | themselves dynamically from API responses which makes it compatible | |
| 7 | with a wide range of versions of the OpenAI API. | |
| 8 | | |
| 9 | This library additionally provides an `openai` command-line utility | |
| 10 | which makes it easy to interact with the API from your terminal. Run | |
| 11 | `openai api -h` for usage. | |
| 12 | | |
| 13 | ## Documentation | |
| 14 | | |
| 15 | See the [OpenAI API docs](https://beta.openai.com/docs/api-reference?lang=python). (During | |
| 16 | the beta, you'll need to be signed into your account to see them.) | |
| 17 | | |
| 18 | ## Installation | |
| 19 | | |
| 20 | You don't need this source code unless you want to modify the package. If you just | |
| 21 | want to use the package, just run: | |
| 22 | | |
| 23 | ```sh | |
| 24 | pip install --upgrade openai | |
| 25 | ``` | |
| 26 | | |
| 27 | Install from source with: | |
| 28 | | |
| 29 | ```sh | |
| 30 | python setup.py install | |
| 31 | ``` | |
| 32 | | |
| 33 | ## Requirements | |
| 34 | | |
| 35 | - Python 2.7+ or Python 3.4+ (PyPy supported) | |
| 36 | | |
| 37 | In general we want to support the versions of Python that our | |
| 38 | customers are using, so if you run into issues with any version | |
| 39 | issues, please let us know at support@openai.com. | |
| 40 | | |
| 41 | ## Credit | |
| 42 | | |
| 43 | This library is forked from the [Stripe Python Library](https://github.com/stripe/stripe-python). |