Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/anze3db/django-tui

Inspect and run Django Commands in a text-based user interface (TUI)
https://github.com/anze3db/django-tui

command-line django python textual tui

Last synced: 6 days ago
JSON representation

Inspect and run Django Commands in a text-based user interface (TUI)

Host: GitHub
URL: https://github.com/anze3db/django-tui
Owner: anze3db
License: mit
Created: 2023-08-23T15:56:59.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-10-16T18:36:34.000Z (2 months ago)
Last Synced: 2024-12-14T07:05:16.290Z (13 days ago)
Topics: command-line, django, python, textual, tui
Language: Python
Homepage:
Size: 132 KB
Stars: 268
Watchers: 5
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-textualize-projects - Django-TUI - Inspect and run Django Commands in a text-based user interface (TUI). (Community / Third Party Applications)
stars - anze3db/django-tui - Inspect and run Django Commands in a text-based user interface (TUI) (Python)
stars - anze3db/django-tui - Inspect and run Django Commands in a text-based user interface (TUI) (Python)

README

        
![Screenshot 2023-10-24 at 11 27 56](https://github.com/anze3db/django-tui/assets/513444/54bc6c84-267c-4e28-9d49-8b30391470ea)

# django-tui

Inspect and run Django Commands in a text-based user interface (TUI), built with [Textual](https://github.com/Textualize/textual) & [Trogon](https://github.com/Textualize/trogon).

[![PyPI - Version](https://img.shields.io/pypi/v/django-tui.svg)](https://pypi.org/project/django-tui)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-tui.svg)](https://pypi.org/project/django-tui)

-----

**Table of Contents**

- [Demo](#demo)

- [Installation](#installation)

- [Running](#running)

- [License](#license)

## 🎬 Demos

### Running Django Commands

https://github.com/anze3db/django-tui/assets/513444/fc84247a-9f4b-4017-9ae4-3f10fe9d9557

### Running ORM Queries in Interactive Django Shell

https://github.com/anze3db/django-tui/assets/513444/8a056da8-85a8-4086-9fa8-433b7346e787

## Installation

```console

pip install django-tui

```

Add `"django_tui"` to your `INSTALLED_APPS` setting in `settings.py` like this:

```python

INSTALLED_APPS = [

    ...,

    "django_tui",

]

```

Now you can run the TUI with:

```console

python manage.py tui

```

## License

`django-tui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

## Looking for Django Admin in your termain?

Checkout [@valberg](https://github.com/valberg)'s [django-admin-tui](https://github.com/valberg/django-admin-tui) project!