Skip to main content

A rich TUI replacement for Django's shell_plus — browse models, querysets, and management commands from your terminal.

Project description

🟢 django-shreck

A rich TUI replacement for Django's shell_plus — browse models and querysets from your terminal.

Python 3.11+ Django 4.2+ License: MIT

Screenshots

Shell and table view Detail view

Inline editing Side-by-side compare

🎬 Watch the screencast

Features

  • Auto-imported models — All your Django models are available immediately with tab completion
  • Interactive shell — Full Python REPL with auto-imported models and history
  • Scrollable table view — QuerySets are rendered as rich, scrollable tables
  • Detail browser — Single objects displayed as navigable key-value detail views
  • Inline editing — Edit and save single model instances directly from the TUI
  • Side-by-side compare — Two objects rendered in a diff-style comparison view
  • Admin integration — Single keypress opens the Django admin for any object or queryset

Installation

pip install django-shreck

Add to your INSTALLED_APPS:

INSTALLED_APPS = [
    # ...
    "django_shreck",
]

Usage

python manage.py shreck

Keybindings

Key Action
q Quit
a Open admin for current object/queryset
Enter Execute shell input
↑/↓ Browse fields / scroll table
Tab Auto-complete

Development

git clone https://github.com/belda/django-shreck.git
cd django-shreck
python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
make test

License

MIT

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

django_shreck-0.1.5.tar.gz (837.7 kB view details)

Uploaded Source

Built Distribution

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

django_shreck-0.1.5-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file django_shreck-0.1.5.tar.gz.

File metadata

  • Download URL: django_shreck-0.1.5.tar.gz
  • Upload date:
  • Size: 837.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for django_shreck-0.1.5.tar.gz
Algorithm Hash digest
SHA256 36af84c88a069da1297f820ea7af1b4895c85f2df718c5ec296ea17b04ec1b10
MD5 0943b32ceac55d31536733c1bce890f0
BLAKE2b-256 ab0bbac6eddce21be7b0b9c3c13d5bfd6b139a34ea03418bf2aa4592dd87a26e

See more details on using hashes here.

File details

Details for the file django_shreck-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: django_shreck-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for django_shreck-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9c576595ffccbcbb11b132e368d41e0170653893c07f24a77ef6afb5758ac4c0
MD5 109e0a1684d34f3a8f2740631b201934
BLAKE2b-256 5caa0c5b892fff8fdce2425c07761131702fc3523804450cf590477af5816a89

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