// readme

Dachshund

A live admin dashboard for any Python service, embedded in the process itself.

Beta. Dachshund works, but its API may still change between releases. Pin a version before depending on it.

What is Dachshund

Dachshund runs as a thread inside your web app, bot, worker or daemon. There’s no router to hook into and no extra service to deploy. Declare pages and widgets in code, emit events from anywhere, and the dashboard updates live over WebSocket.

Key features

  • Embedded: starts with your process, nothing else to run
  • Live: every emit() reaches the open pages as it happens
  • Pages: group widgets into pages and tabs, lay them out in rows and columns
  • Actions: buttons that call your own Python functions
  • Authentication: plug in your app’s own auth, with public and private pages
  • Extensible: write your own widgets in a few lines of Python and JavaScript

Getting Started

1- Install the package

Requirements: Python 3.12 or higher

pip install dachshund

2- Start the dashboard

Call init() once, when your application starts. The dashboard runs on a background thread for as long as your process…