Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/synw/django-term
In browser terminal for Django
https://github.com/synw/django-term
django-instant
Last synced: about 1 month ago
JSON representation
In browser terminal for Django
- Host: GitHub
- URL: https://github.com/synw/django-term
- Owner: synw
- License: mit
- Created: 2017-08-05T16:24:04.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-13T09:56:49.000Z (almost 7 years ago)
- Last Synced: 2024-09-21T09:15:45.687Z (about 2 months ago)
- Topics: django-instant
- Language: JavaScript
- Size: 178 KB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Django Term
In browser terminal for Django that enables custom commands
## Install
Dependency: [Django Instant](https://github.com/synw/django-instant)
for the websockets: [install doc](http://django-instant.readthedocs.io/en/latest/src/install.html)
```
pip install django-term
```
Add `"term",` to installed apps:
Set the urls
```python
from instant.views import instant_auth
urlpatterns = [
url('^terminal/', include('term.urls')),
url('^instant/', include('instant.urls')),
url('^centrifuge/auth/$', instant_auth, name='instant-auth'),
]
```
Add to settings.py:
```python
SITE_SLUG = "mysite"
INSTANT_SUPERUSER_CHANNELS = [
["$" + SITE_SLUG + "_terminal", ["/terminal"]]
]
```
Create a `templates/instant/handlers/$mysite_terminal.js` whith this content:
```django
{% include "term/handlers.js" %}
```
Run the websockets server and go to `/terminal/`
## Commands
Note: to use the commands from third-party apps your must have these apps installed
`help`: display info about the available commands
`ping`: ping the server
`clear`: clears the screen
From [Django Introspection](https://github.com/synw/django-introspection):
`inspect`: gives infos about an app or model. Params: `appname` or `appname.Modelname`: ex: `inspect auth.User`
From [Django Dex](https://github.com/synw/django-dex):
`replicatedb`: replicates the 'default' db into a sqlite 'replica' db
## Create a command
Create a `terminal` folder in any app. Create a `commands.py` file inside this directory:
```python
from term.commands import Command, rprint
def run_hello(request, cmd_args):
rprint("Hello world")
# Args are the command name, the runner function and the help text
c1 = Command("hello", run_hello, "Hello world command")
COMMANDS = [c1]
```
Your command will be detected at startup and enabled in the terminal
To debug a command during developement use ` TERM_DEBUG_MODEL = "mymodel"`
### Apps that have terminal commands:
[django-introspection](https://github.com/synw/django-introspection): get infos about Django objects
[django-dex](https://github.com/synw/django-dex): database export tools
[django-jobrunner](https://github.com/synw/django-jobrunner): experimental asynchronous jobs runner
## Customize the ui
To customize the colors use the `terminal/colors.css` template
## Screenshot
