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 powered by ptpython
  • 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.4.tar.gz (838.2 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.4-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_shreck-0.1.4.tar.gz
  • Upload date:
  • Size: 838.2 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.4.tar.gz
Algorithm Hash digest
SHA256 fe1a66797547686af434944a5059d56326e048a7f9a32ed201621aa0455ad7e2
MD5 ce7045ac6e858692c9459220c511986b
BLAKE2b-256 85d9f7fb73ff939fc0b6310372639ad3003ef7748ede4518ec2405585206d435

See more details on using hashes here.

File details

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

File metadata

  • Download URL: django_shreck-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 27.8 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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5598119d89600215eaeae5f906485c22eac5b387d0a7b1bd84bdfcf5f4f177b8
MD5 c6fc73dfa365d74a568cd5be549a4b56
BLAKE2b-256 4c8093fb7fa1945728064028b3ed50ab57cde3a832d03dcd9cc4d6b622a365d0

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