gestell 1.1.0

The Official Gestell Python SDK

Gestell Python SDK

A fully featured SDK with extensive code completion and typesystems for interacting with the Gestell Platform. Full featured support for Python 3.X. Uses asynchronous coroutines by design.

Quick Start

First, get an API Key from https://platform.gestell.ai. Then install gestell:

pip install gestell

Or...

uv add gestell

Second, load the API Key into your terminal session, or, pass it into the SDK:

# Load it into your terminal session
export GESTELL_API_KEY = "..."

Or load it directly in the client:

from gestell import Gestell


gestell = Gestell(key='...', url='...', debug=True)

Gestell will also read and load these environment variables from a .env file.

Finally, start using the Gestell Platform SDK. The SDK can be used both on the client and server side. A public facing app should use it server side only due to the API Key being passed into the SDK and requests:

import asyncio
from gestell import Gestell


gestell = Gestell()

async def main():
    response = await gestell.collection.list()
    print(response)

if __name__ == "__main__":
    asyncio.run(main())

Guides

You can review guides on common workflows and use cases for the Gestell Platform by going to https://gestell.ai/docs. Here are the most common use cases:

1. Create a collection and upload documents to it

2. Prompt a collection

3. Gather all labels from a collection

4. Gather all tables from a collection

Contributing

All workflows in the SDK use ruff and uv.

Opening an issue to address your concern is recommended. However, if you plan to submit a pull request (PR), please adhere to the following:

1. Align with the Repo Structure: Organize canonical functionality within the appropriate folders. Provide clear documentation and usage annotations in the base class structures.

2. Pass All Unit Tests: Ensure all pytest unit tests pass and maintain near full code coverage.

3. Provide a Detailed PR Description: Clearly outline the changes made and the specific issues they resolve in your pull request.

The workflow is as follows:

# Run unit tests
ruff check
ruff format
uv run pytest
uv run coveralls

# Compile a new dist
uv venv
rm -rf dist
uv build

# Verify and test the package externally with uv and a normal venv environment
cd ..
uv init test
cd test
uv add ../python-sdk
uv pip install ../python-sdk/dist/gestell-1.1.0-py3-none-any.whl