ineepy 0.3.0

A Python client library for the [ineep](https://codeberg.org/cmts/ineep) lakehouse API.

ineepy

A Python client library for the ineep lakehouse API.

Links

• Repository: codeberg.org/Ineep/ineepy
• Documentation: ineep.codeberg.page/ineepy/
• Changelog: CHANGELOG.md

Requirements

• Python 3.14+
• uv

Installation

uv add ineepy

Or for development:

git clone https://codeberg.org/Ineep/ineepy
cd ineepy
uv sync

Usage

Authentication

Obtain a JWT token before creating a client:

from ineepy import get_token, async_get_token

# Synchronous
token = get_token(email='[e-mail]', password='secret')

# Async
token = await async_get_token(email='[e-mail]', password='secret')

The scope parameter defaults to 'user'. Use 'admin' for administrative operations.

Synchronous client

from ineepy import Ineepy, get_token

token = get_token(email='[e-mail]', password='secret')

with Ineepy(token=token) as client:
    user, etag = client.users.me()
    namespaces = client.namespaces.list()
    tables = client.tables.list(namespace_id='my-namespace')

Async client

from ineepy import AsyncIneepy, async_get_token

token = await async_get_token(email='[e-mail]', password='secret')

async with AsyncIneepy(token=token) as client:
    user, etag = await client.users.me()
    namespaces = await client.namespaces.list()

Configuration

The base URL defaults to http://localhost:8000 and can be overridden via environment variable or constructor argument:

export INEEPY_BASE_URL=https://my-server.example.com
export INEEPY_API_VERSION=v0   # default

client = Ineepy(base_url='https://my-server.example.com', token=token)

Resources

Resource	Access	Description
users	client.users	User management (list, get, create, update, delete)
api_keys	client.api_keys	API key management (create, list, revoke)
namespaces	client.namespaces	Namespace management (list, create, update, delete); list() with no arg returns root namespaces
tables	client.tables	Table schema management within namespaces
data	client.data	Upload, query, and explicit write modes: append, overwrite, upsert

Development

make format   # format code
make lint     # lint code
make test     # run unit tests with coverage
make test-e2e # run end-to-end tests against a live server

E2E tests

E2E tests require a running ineep server and admin credentials:

cp .env.example .env
# edit .env with your credentials
make test-e2e

The .env file is gitignored. See .env.example for the available variables.

Project structure

src/ineepy/          Main package
  _auth.py           Token acquisition (sync + async)
  _client.py         Ineepy and AsyncIneepy clients
  _config.py         Pydantic settings (env vars)
  _exceptions.py     Exception hierarchy
  _models.py         Pydantic response models
  exceptions.py      Public exceptions re-export
  helpers.py         Public helper utilities
  models.py          Public models re-export
  _resources/        Per-resource implementations
    api_keys.py
    data.py
    namespaces.py
    tables.py
    users.py
tests/
  resources/         Unit tests per resource
  e2e/               End-to-end workflow tests
scripts/             Shell scripts called by make
pyproject.toml       Project metadata and tool config

License

This project is licensed under the GNU General Public License v3.0.

You are free to use, modify, and distribute this software under the terms of the GPL v3. Any derivative work must also be distributed under the same license. See the LICENSE file for the full license text.