GitVita
New repositoryImport repositoryNew issue
Your repositories Your dashboard Sign in

openai/openai-python

Public

mirrored from https://github.com/openai/openai-pythonAvailable

Watch0Fork0Star0
CodeCommitsIssuesPull requestsActionsInsightsSecurity
v1.61.0

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

CONTRIBUTING.md

129lines · modeblame

RawDownload
Latest commit unavailable.
93f3d3c3Stainless Bot2 years ago1## Setting up the environment
2
3### With Rye
4
a3001d8dStainless Bot1 years ago5We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run:
93f3d3c3Stainless Bot2 years ago6
a3001d8dStainless Bot1 years ago7```sh
8$ ./scripts/bootstrap
9```
10
11Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run:
93f3d3c3Stainless Bot2 years ago12
13```sh
14$ rye sync --all-features
15```
16
17You can then run scripts using `rye run python script.py` or by activating the virtual environment:
18
19```sh
20$ rye shell
21# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
22$ source .venv/bin/activate
23
24# now you can omit the `rye run` prefix
25$ python script.py
26```
27
28### Without Rye
29
30Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command:
31
32```sh
33$ pip install -r requirements-dev.lock
34```
35
36## Modifying/Adding code
37
f6323473stainless-app[bot]1 years ago38Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
39result in merge conflicts between manual patches and changes from the generator. The generator will never
40modify the contents of the `src/openai/lib/` and `examples/` directories.
93f3d3c3Stainless Bot2 years ago41
42## Adding and running examples
43
f6323473stainless-app[bot]1 years ago44All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
93f3d3c3Stainless Bot2 years ago45
50de514bstainless-app[bot]1 years ago46```py
93f3d3c3Stainless Bot2 years ago47# add an example to examples/<your-example>.py
48
49#!/usr/bin/env -S rye run python
50…
51```
52
a3001d8dStainless Bot1 years ago53```sh
54$ chmod +x examples/<your-example>.py
93f3d3c3Stainless Bot2 years ago55# run the example against your api
a3001d8dStainless Bot1 years ago56$ ./examples/<your-example>.py
93f3d3c3Stainless Bot2 years ago57```
58
59## Using the repository from source
60
61If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
62
63To install via git:
64
a3001d8dStainless Bot1 years ago65```sh
66$ pip install git+ssh://git@github.com/openai/openai-python.git
93f3d3c3Stainless Bot2 years ago67```
68
69Alternatively, you can build from source and install the wheel file:
70
71Building this package will create two files in the `dist/` directory, a `.tar.gz` containing the source files and a `.whl` that can be used to install the package efficiently.
72
73To create a distributable version of the library, all you have to do is run this command:
74
a3001d8dStainless Bot1 years ago75```sh
76$ rye build
93f3d3c3Stainless Bot2 years ago77# or
a3001d8dStainless Bot1 years ago78$ python -m build
93f3d3c3Stainless Bot2 years ago79```
80
81Then to install:
82
83```sh
a3001d8dStainless Bot1 years ago84$ pip install ./path-to-wheel-file.whl
93f3d3c3Stainless Bot2 years ago85```
86
87## Running tests
88
25cef3d9Stainless Bot2 years ago89Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
93f3d3c3Stainless Bot2 years ago90
a3001d8dStainless Bot1 years ago91```sh
93f3d3c3Stainless Bot2 years ago92# you will need npm installed
a3001d8dStainless Bot1 years ago93$ npx prism mock path/to/your/openapi.yml
93f3d3c3Stainless Bot2 years ago94```
95
a3001d8dStainless Bot1 years ago96```sh
97$ ./scripts/test
93f3d3c3Stainless Bot2 years ago98```
99
100## Linting and formatting
101
102This repository uses [ruff](https://github.com/astral-sh/ruff) and
103[black](https://github.com/psf/black) to format the code in the repository.
104
105To lint:
106
a3001d8dStainless Bot1 years ago107```sh
108$ ./scripts/lint
93f3d3c3Stainless Bot2 years ago109```
110
111To format and fix all ruff issues automatically:
112
a3001d8dStainless Bot1 years ago113```sh
114$ ./scripts/format
93f3d3c3Stainless Bot2 years ago115```
116
117## Publishing and releases
118
119Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If
120the changes aren't made through the automated pipeline, you may want to make releases manually.
121
122### Publish with a GitHub workflow
123
25cef3d9Stainless Bot2 years ago124You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/openai/openai-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
93f3d3c3Stainless Bot2 years ago125
126### Publish manually
127
c9ed0f54Stainless Bot2 years ago128If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
93f3d3c3Stainless Bot2 years ago129the environment.