{"id":15563937,"url":"https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer","last_synced_at":"2025-04-09T16:52:51.506Z","repository":{"id":43751452,"uuid":"184351373","full_name":"mrsarm/tornado-dcoleman-mtasks-viewer","owner":"mrsarm","description":"Web application to view task orders from Django Coleman, built with Tornado and Python 3.6+","archived":false,"fork":false,"pushed_at":"2024-04-30T22:24:01.000Z","size":55,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-23T19:02:18.327Z","etag":null,"topics":["python3","python3-asyncio","tornado-framework","webapplication"],"latest_commit_sha":null,"homepage":null,"language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mrsarm.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-05-01T00:51:56.000Z","updated_at":"2024-11-22T20:40:17.000Z","dependencies_parsed_at":"2024-04-29T13:34:21.440Z","dependency_job_id":null,"html_url":"https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrsarm%2Ftornado-dcoleman-mtasks-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrsarm%2Ftornado-dcoleman-mtasks-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrsarm%2Ftornado-dcoleman-mtasks-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mrsarm%2Ftornado-dcoleman-mtasks-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mrsarm","download_url":"https://codeload.github.com/mrsarm/tornado-dcoleman-mtasks-viewer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248073594,"owners_count":21043472,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["python3","python3-asyncio","tornado-framework","webapplication"],"created_at":"2024-10-02T16:31:24.342Z","updated_at":"2025-04-09T16:52:51.482Z","avatar_url":"https://github.com/mrsarm.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: docs/source/_static/img/dcoleman-viewer.png\n   :scale: 50 %\n\n(Tornado) Django Coleman Viewer\n===============================\n\n**IN PROGRESS**: Simple web application to view task orders from\n`Django Coleman \u003chttps://github.com/mrsarm/django-coleman\u003e`_,\nbuilt with `Tornado Framework \u003chttps://www.tornadoweb.org/en/stable/\u003e`_.\n\nThis is just a PoC using Tornado web framework and\nPython 3+ async programming, and Django Coleman as API,\nit's not a full featured, production ready application.\n\n\nRequirements\n------------\n\nDocker, or:\n\n* Python 3.8+\n* Tornado framework installed (tested with version 6 and 6.1)\n* Django Coleman running at the URL pointed\n  by the ``DCOLEMAN_ENDPOINT`` environment\n  variable (by default it uses ``http://localhost:8000/api/v1``)\n\n\nInstall and Run\n---------------\n\nInstall ``tornado`` with::\n\n   $ pip3 install tornado\n\n(use virtual environments!)\n\nRun with::\n\n   $ ./app.py\n\nRun changing the Django Coleman endpoint with::\n\n   $ DCOLEMAN_ENDPOINT=http://HOSTNAME/api/v1 ./app.py\n\n\nAccess the application\n----------------------\n\nIf the order number is *123*, the URL to access\nit is: http://localhost:8888/123?t=porgs\n\nThe argument ``t`` is the master token, by default ``porgs``...\n\n.. image:: https://media.giphy.com/media/3ohhwqOVlEbBxEbss0/giphy.gif\n\n... but each time Django Coleman creates an order, it sends an\nemail with the order URL signed with a unique token so users cannot\nreuse the token to see other orders.\n\n\nSettings\n--------\n\n+-------------------------------------+----------------------------------+--------------------------------------------------------------+\n| **Environment variable**            | **Default value**                | **Description**                                              |\n+-------------------------------------+----------------------------------+--------------------------------------------------------------+\n| ``DCOLEMAN_ENDPOINT``               | ``http://localhost:8000/api/v1`` | Django Coleman API URL                                       |\n+-------------------------------------+----------------------------------+--------------------------------------------------------------+\n| ``DCOLEMAN_MASTER_TOKEN``           | ``porgs``                        | Master token (**CHANGE IT** in production)                   |\n+-------------------------------------+----------------------------------+--------------------------------------------------------------+\n| ``DCOLEMAN_TASKS_VIEWER_HASH_SALT`` | ``1two3``                        | Same value than ``TASKS_VIEWER_HASH_SALT`` in Django Coleman |\n+---------------------------+---------+----------------------------------+--------------------------------------------------------------+\n\n\nDocker\n------\n\nA reference `\u003cDockerfile\u003e`_ is provided, and the image published\nin `Docker Hub \u003chttps://hub.docker.com/r/mrsarm/django-coleman-mtasks-viewer\u003e`_.\n\nAlso a ``compose.yaml`` in the\n`dcoleman-e2e \u003chttps://github.com/mrsarm/dcoleman-e2e\u003e`_ project is provided,\nyou can build and run the app with Docker Compose with::\n\n    $ docker compose up\n\n\nAbout\n-----\n\n**Project**: https://github.com/mrsarm/tornado-dcoleman-mtasks-viewer\n\n**Authors**: (2019-2024) Mariano Ruiz \u003cmrsarm@gmail.com\u003e\n\n**License**: AGPL-v3\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrsarm%2Ftornado-dcoleman-mtasks-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmrsarm%2Ftornado-dcoleman-mtasks-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmrsarm%2Ftornado-dcoleman-mtasks-viewer/lists"}