Skip to main content

Assistant tooling for SENSEI projects.

Project description

Senpai Assistant

Senpai Assistant is a Python package for building and running a SENSEI-focused assistant. It provides a console entry point and a public Python API for host applications that need to create assistants over SENSEI project files, connector files, reference docs, embeddings, and an external conversation checkpointer.

Installation

pip install senpai-assistant

The package requires Python 3.12 or newer.

CLI

After installation, run the assistant with:

senpai-assistant --help

You can also run the module directly:

python -m senpai_assistant --help

Python API

from pathlib import Path

from senpai_assistant import create_assistant_for_paths

assistant = create_assistant_for_paths(
    user_path=Path("/path/to/users/user_1"),
    thread_id="thread-1",
    runtime_root=Path("/var/lib/senpai-assistant"),
    checkpointer=checkpointer,
)

checkpointer should be a LangGraph checkpointer provided by the host application. For local CLI-style usage without an external checkpointer, pass require_checkpointer=False to allow the SQLite fallback.

The public package exports:

  • Assistant
  • create_assistant_for_paths(...)
  • configure_runtime_root(...)
  • get_runtime_root()
  • main

create_assistant_for_paths(...) expects a SENSEI user directory containing connectors/ and projects/. Projects are discovered from user_path / "projects". In hosted deployments, pass an external LangGraph checkpointer so conversation state is not stored in local SQLite.

Runtime Files

Senpai Assistant writes generated runtime artifacts under the configured runtime root. The resolution order is:

  1. An explicit runtime_root argument.
  2. The process-wide root set with configure_runtime_root(...).
  3. The SENPAI_HOME environment variable.
  4. The default user data location for the current platform.

Embedding indexes are stored under that runtime root. Local CLI usage can fall back to SQLite, but application integrations should pass their own checkpointer.

Releases

Releases are published from tags named vX.Y.Z. The tag version must match the version in pyproject.toml, and CHANGELOG.md must contain a matching ## [X.Y.Z] section.

uv version 0.1.1
git add pyproject.toml uv.lock CHANGELOG.md
git commit -m "Release 0.1.1"
git tag v0.1.1
git push origin main --tags

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

senpai_assistant-0.4.0.tar.gz (118.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

senpai_assistant-0.4.0-py3-none-any.whl (98.5 kB view details)

Uploaded Python 3

File details

Details for the file senpai_assistant-0.4.0.tar.gz.

File metadata

  • Download URL: senpai_assistant-0.4.0.tar.gz
  • Upload date:
  • Size: 118.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for senpai_assistant-0.4.0.tar.gz
Algorithm Hash digest
SHA256 60d016161dd8a6b0191aa4eaa604c79345b0c51c3aa3dc05a36f7841ba57cca6
MD5 e159ebda4acb8eb8a8dd6ba621673b0e
BLAKE2b-256 9226249a573c8986cc181751adb8e49d061a262dd66dd1323cec9e925cfb9ebd

See more details on using hashes here.

File details

Details for the file senpai_assistant-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: senpai_assistant-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 98.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for senpai_assistant-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f18269a665524faa48acacc9b34256794e2c6c2305ef7c2a975ca27483d161a1
MD5 ff66e4b9077730352890494b94d1cc92
BLAKE2b-256 bf5e92655c52bc118ef02e93d1371a32b3f42d09743efe225e86d079167067af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page