52 lines (35 loc) · 1.34 KB

Contributing to the Galileo Python SDK

Local Installation

Pre-Requisites

Clone this repo locally.
Install pyenv.
Install poetry: curl -sSL https://install.python-poetry.org | python3 -

Setup

Setup a virtual environment:
```
pyenv install 3.13
pyenv local 3.13
```
poetry will create a virtual environment using that Python version when it installs dependencies.
NOTE: In Poetry 2.x, the shell command was moved to a separate plugin: poetry-plugin-shell. Install it via Poetry's self add:
```
poetry self add poetry-plugin-shell
```
You can validate the Python version with:
```
poetry run python --version
```
which should print out Python 3.13.x. To activate the virtual environment in your shell, run poetry shell.
Install dependencies and setup pre-commit hooks:
```
pip3 install --upgrade invoke
inv setup
```
Run unit tests
```
poetry run pytest
```

Auto-generating the API client

Run ./scripts/import-openapi-yaml.sh https://api.galileo.ai/client to update the openapi.yml file with the latest client spec
Run ./scripts/auto-generate-api-client.sh to generate the API client