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.1.1.tar.gz (110.5 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.1.1-py3-none-any.whl (91.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: senpai_assistant-0.1.1.tar.gz
  • Upload date:
  • Size: 110.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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.1.1.tar.gz
Algorithm Hash digest
SHA256 ee6ca0d3ab4a98bf7447a055cbda2756c85bb20509c0bf26c23ad727626abcaa
MD5 7a3b921051a12965a1ae984167638332
BLAKE2b-256 bc0cd0c1284ad0cda7275b8043c41839b0c22ddd0728858dcfbd975a4b4bdc46

See more details on using hashes here.

File details

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

File metadata

  • Download URL: senpai_assistant-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 91.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.6 {"installer":{"name":"uv","version":"0.11.6","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.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e8b8c91b07d1b5fc61ee41cece6a5c48781b88e79db23fae51d78150b1d70f98
MD5 7bf1e6ac741b87bea12af09be5e5ed28
BLAKE2b-256 bffcdc2d15e0f9044e4e400f802d2328a05a6e88b724a2b4aa9e24d8f1a12305

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