Skip to main content

OpenPawlet console with embedded nanobot AI assistant framework

Project description

OpenPawlet

Languages: 中文说明

What it is

OpenPawlet (PyPI package name open-pawlet) is a web console for the nanobot ecosystem. It exposes an HTTP API and a browser UI that works alongside the nanobot gateway over WebSocket so you can manage bot-related resources locally or in deployment.

Stack: FastAPI backend (consistent error envelope and OpenAPI; docs can be disabled in production via settings) and a Vite frontend under src/console/web (HMR in development, production build supported).

Feature areas

The console roughly covers the areas below (see the UI and OpenAPI for the exact surface):

Area Capabilities
Bots & agents Inspect and manage bots and agents
Chat & channels Sessions, chat, channels; debug with gateway WebSocket and realtime events
Config & env Console and bot configuration, environment variables, bot file access (e.g. bot_files)
Tools & extensions Tools, MCP servers, skills, memory
Automation Cron jobs
Ops & observability Status, health, health audit, usage, alerts, activity; control endpoints where applicable
Workspace Workspace browsing and management

Typical use: run next to nanobot gateway to inspect status, debug sessions, and manage these resources from the console.

Architecture notes

  • Backend: FastAPI-based OpenPawlet service with a consistent error envelope and OpenAPI documentation.
  • Frontend: Vite app under src/console/web, with HMR in development and a production build path.

Tech stack

Layer Technology
Runtime Python ≥ 3.11
Backend FastAPI, Uvicorn, Pydantic v2, Loguru
nanobot integration Bundled in this repo (src/nanobot); installed as part of open-pawlet
Frontend Node.js + npm (see src/console/web)
Multi-process (optional) Honcho + Procfile

Quick start

1. Virtual environment and install

A project-local .venv is recommended:

python3.11 -m venv .venv
source .venv/bin/activate   # Windows: .venv\Scripts\activate
pip install --upgrade pip
pip uninstall -y nanobot-ai  # if you still had the old PyPI package; otherwise skip
pip install -e ".[dev]"

The nanobot Python package ships inside this repository; pip install -e ".[dev]" installs the console and nanobot together.

2. Frontend dependencies

cd src/console/web && npm install && cd ../../..

3. Run

API only (defaults to 0.0.0.0:8000; tune with NANOBOT_SERVER_* env vars, see ServerSettings):

console server

Frontend dev:

console web dev

All-in-one (requires honcho and a working nanobot CLI for the gateway):

honcho start

The default Procfile runs: nanobot gateway, console server, and console web dev.

Version history (timeline)

Major releases for the open-pawlet PyPI package (matches [project] version in the root pyproject.toml). Newest at the top; older entries below. Add new rows at the top when you cut a release.

2026-04-19 ──●── 0.2.1  Aligned versions (pyproject, API schema, web package.json)
              │
2026-04-19 ──●── 0.2.0  Deps & packaging; README; bundled nanobot; WhatsApp bridge under bridge/
              │
2026-04-19 ──●── 0.1.0  First release: FastAPI console, CLI, workspace, README / Procfile
Date Version Summary
2026-04-19 0.2.1 Single source of truth for version strings across the Python package, server API version field, and frontend package.json.
2026-04-19 0.2.0 Dependency and optional extras cleanup, install docs; nanobot bundled in-repo; bridge/ (including WhatsApp-related pieces).
2026-04-19 0.1.0 Initial OpenPawlet: FastAPI backend, console CLI, workspace features, docs, and Honcho/Procfile entry points.

License

MIT — see LICENSE in the repository root.

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

open_pawlet-0.2.2.tar.gz (820.6 kB view details)

Uploaded Source

Built Distribution

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

open_pawlet-0.2.2-py3-none-any.whl (992.3 kB view details)

Uploaded Python 3

File details

Details for the file open_pawlet-0.2.2.tar.gz.

File metadata

  • Download URL: open_pawlet-0.2.2.tar.gz
  • Upload date:
  • Size: 820.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for open_pawlet-0.2.2.tar.gz
Algorithm Hash digest
SHA256 f4a048ae3718145572099f60a10653243e88fce967d803a036cced93fb70fe65
MD5 481f91871d4dccbed1c2acfc2cfef5bb
BLAKE2b-256 9617af57fb6e76023a51b48201d9c21ddf57d36ae216c016e88483f2a9a18d0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_pawlet-0.2.2.tar.gz:

Publisher: publish.workflow.yml on JackLuguibin/OpenPawlet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file open_pawlet-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: open_pawlet-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 992.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for open_pawlet-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 746d7fbac9eed7e8a1796784df1657f8ad3807b71e12e7eb00eb9604d04c73b1
MD5 a1472ed3d640748da663e2a833fa7cb8
BLAKE2b-256 26f6bdfa7f39137eb4c4edd6dd47c8f93e2349531ca0d5d35d1c2ba2d5c8c50a

See more details on using hashes here.

Provenance

The following attestation bundles were made for open_pawlet-0.2.2-py3-none-any.whl:

Publisher: publish.workflow.yml on JackLuguibin/OpenPawlet

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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