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.15.0

Branches

Tags

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

Clone

HTTPS

Download ZIP

CONTRIBUTING.md

125lines · modeblame

RawDownload
Latest commit unavailable.
93f3d3c3Stainless Bot2 years ago1## Setting up the environment
2
3### With Rye
4
5We use [Rye](https://rye-up.com/) to manage dependencies so we highly recommend [installing it](https://rye-up.com/guide/installation/) as it will automatically provision a Python environment with the expected Python version.
6
7After installing Rye, you'll just have to run this command:
8
9```sh
10$ rye sync --all-features
11```
12
13You can then run scripts using `rye run python script.py` or by activating the virtual environment:
14
15```sh
16$ rye shell
17# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
18$ source .venv/bin/activate
19
20# now you can omit the `rye run` prefix
21$ python script.py
22```
23
24### Without Rye
25
26Alternatively 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:
27
28```sh
29$ pip install -r requirements-dev.lock
30```
31
32## Modifying/Adding code
33
34Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
35`src/openai/lib/` and `examples/` directories are exceptions and will never be overridden.
36
37## Adding and running examples
38
39All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
40added to.
41
42```bash
43# add an example to examples/<your-example>.py
44
45#!/usr/bin/env -S rye run python
46…
47```
48
49```
50chmod +x examples/<your-example>.py
51# run the example against your api
52./examples/<your-example>.py
53```
54
55## Using the repository from source
56
57If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
58
59To install via git:
60
61```bash
1879c97aStainless Bot2 years ago62pip install git+ssh://git@github.com/openai/openai-python.git
93f3d3c3Stainless Bot2 years ago63```
64
65Alternatively, you can build from source and install the wheel file:
66
67Building 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.
68
69To create a distributable version of the library, all you have to do is run this command:
70
71```bash
72rye build
73# or
74python -m build
75```
76
77Then to install:
78
79```sh
80pip install ./path-to-wheel-file.whl
81```
82
83## Running tests
84
25cef3d9Stainless Bot2 years ago85Most 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 ago86
87```bash
88# you will need npm installed
5cfb125aStainless Bot2 years ago89npx prism mock path/to/your/openapi.yml
93f3d3c3Stainless Bot2 years ago90```
91
92```bash
93rye run pytest
94```
95
96## Linting and formatting
97
98This repository uses [ruff](https://github.com/astral-sh/ruff) and
99[black](https://github.com/psf/black) to format the code in the repository.
100
101To lint:
102
103```bash
104rye run lint
105```
106
107To format and fix all ruff issues automatically:
108
109```bash
110rye run format
111```
112
113## Publishing and releases
114
115Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If
116the changes aren't made through the automated pipeline, you may want to make releases manually.
117
118### Publish with a GitHub workflow
119
25cef3d9Stainless Bot2 years ago120You 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 ago121
122### Publish manually
123
c9ed0f54Stainless Bot2 years ago124If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
93f3d3c3Stainless Bot2 years ago125the environment.