Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer
Web application to view task orders from Django Coleman, built with Tornado and Python 3.6+
https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer
python3 python3-asyncio tornado-framework webapplication
Last synced: about 1 month ago
JSON representation
Web application to view task orders from Django Coleman, built with Tornado and Python 3.6+
- Host: GitHub
- URL: https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer
- Owner: mrsarm
- License: agpl-3.0
- Created: 2019-05-01T00:51:56.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-04-30T22:24:01.000Z (7 months ago)
- Last Synced: 2024-10-03T16:31:17.296Z (about 1 month ago)
- Topics: python3, python3-asyncio, tornado-framework, webapplication
- Language: HTML
- Size: 53.7 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: COPYING
Awesome Lists containing this project
README
.. image:: docs/source/_static/img/dcoleman-viewer.png
:scale: 50 %
(Tornado) Django Coleman Viewer
===============================
**IN PROGRESS**: Simple web application to view task orders from
`Django Coleman `_,
built with `Tornado Framework `_.
This is just a PoC using Tornado web framework and
Python 3+ async programming, and Django Coleman as API,
it's not a full featured, production ready application.
Requirements
------------
Docker, or:
* Python 3.8+
* Tornado framework installed (tested with version 6 and 6.1)
* Django Coleman running at the URL pointed
by the ``DCOLEMAN_ENDPOINT`` environment
variable (by default it uses ``http://localhost:8000/api/v1``)
Install and Run
---------------
Install ``tornado`` with::
$ pip3 install tornado
(use virtual environments!)
Run with::
$ ./app.py
Run changing the Django Coleman endpoint with::
$ DCOLEMAN_ENDPOINT=http://HOSTNAME/api/v1 ./app.py
Access the application
----------------------
If the order number is *123*, the URL to access
it is: http://localhost:8888/123?t=porgs
The argument ``t`` is the master token, by default ``porgs``...
.. image:: https://media.giphy.com/media/3ohhwqOVlEbBxEbss0/giphy.gif
... but each time Django Coleman creates an order, it sends an
email with the order URL signed with a unique token so users cannot
reuse the token to see other orders.
Settings
--------
+-------------------------------------+----------------------------------+--------------------------------------------------------------+
| **Environment variable** | **Default value** | **Description** |
+-------------------------------------+----------------------------------+--------------------------------------------------------------+
| ``DCOLEMAN_ENDPOINT`` | ``http://localhost:8000/api/v1`` | Django Coleman API URL |
+-------------------------------------+----------------------------------+--------------------------------------------------------------+
| ``DCOLEMAN_MASTER_TOKEN`` | ``porgs`` | Master token (**CHANGE IT** in production) |
+-------------------------------------+----------------------------------+--------------------------------------------------------------+
| ``DCOLEMAN_TASKS_VIEWER_HASH_SALT`` | ``1two3`` | Same value than ``TASKS_VIEWER_HASH_SALT`` in Django Coleman |
+---------------------------+---------+----------------------------------+--------------------------------------------------------------+
Docker
------
A reference ``_ is provided, and the image published
in `Docker Hub `_.
Also a ``compose.yaml`` in the
`dcoleman-e2e `_ project is provided,
you can build and run the app with Docker Compose with::
$ docker compose up
About
-----
**Project**: https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer
**Authors**: (2019-2024) Mariano Ruiz
**License**: AGPL-v3