https://github.com/thekevjames/mosura

task management system
https://github.com/thekevjames/mosura

bugtracker task

Last synced: 13 days ago
JSON representation

task management system

• Host: GitHub
• URL: https://github.com/thekevjames/mosura
• Owner: TheKevJames
• License: mit
• Created: 2020-03-15T19:22:50.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-30T04:02:09.000Z (2 months ago)
• Last Synced: 2024-10-30T07:13:26.374Z (2 months ago)
• Topics: bugtracker, task
• Language: Python
• Size: 1.43 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.rst
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
Mosura

======

Mosura is an opinionated Task management frontend. Overall project goals are:

* **usage agnostic**: team members using Mosura should not conflict with those

  who do not

* **minimal views**: if you don't use a feature, it shouldn't bloat your

  interface or slow you down

* **opinionated workflows**: Mosura assumes you're looking for a simplified

  experience and trims out all the inessential cruft

I don't currently expect Mosura to be useful for anyone but myself. Maybe

eventually!

Usage

-----

First off, you'll need to `create a Jira API token`_.

Best run via docker/podman/etc:

.. code-block:: console

    docker run -d \

        --name=mosura \

        -p 8080:8080 \

        -v /path/to/appdata:/data \

        -e JIRA_AUTH_TOKEN=mytoken123456 \

        -e [email protected] \

        -e JIRA_DOMAIN=https://myinstance.atlassian.net \

        -e JIRA_LABEL_OKR=okr \  # (optional, default: okr)

        -e JIRA_PROJECT=MOS \

        -e JIRA_TEAM='1234-5678' \  # (optional, id)

        -e JIRA_OTHER_PROJECTS='ASDF,FDSA' \  # (optional, comma-separated)

        -e MOSURA_APPDATA=/data \  # (optional, default: .)

        -e MOSURA_HEADER_USER_EMAIL=X-Token-User-Email \

        -e MOSURA_PORT=8080 \  # (optional, default: 8080)

        --restart unless-stopped \

        quay.io/thekevjames/mosura:latest

# TODO: docker-compose, k8s

Can also be run locally for development purposes:

.. code-block:: console

    export ...

    export MOSURA_USER=...  # force the user without going through auth

    poetry install --sync

    poetry run uvicorn mosura.app:app --reload

In development mode, there's a few extra env vars you may want to set:

.. code-block:: console

    export PYTHONDEVMODE=1

    export PYTHONWARNINGS=error

    export MOSURA_POLL_INTERVAL_OPEN=60

    export MOSURA_POLL_INTERVAL_CLOSED=600

Workflow Assumptions

--------------------

We make the following assumptions about your workflow / project setup. Note

that much of this section also doubles as a "TODO: make these configurable"

list.

Overall, we assume your project is configured at minimum with the following

fields:

* ``key``: eg. ``MOS-123``

* ``summary``: the short title of the ticket

* ``description``: the long-form body of the ticket

* ``status``: the current status of the ticket

  * if you use a ``Needs Triage`` value, it will get highlighted as requiring

    attention in the issue list and coloured red in the timeline

  * ``In Progress`` or ``Code Review`` will get coloured yellow in the timeline

  * ``Closed`` will be red on the chart and will not be visible anywhere else

* ``priority``: the determined priority of the ticket

  * ``Low``, ``Medium``, ``High``, and ``Urgent`` will get special icons

* ``assignee``: the assigned user

  * if the ``assignee`` matches your configured Jira credentials, the "my

    issues" page will work

* ``customfield_12161``: a.k.a. ``Start Date``; if anyone is aware of a builtin

  version of this, I'd love to switch over

* ``Original estimate``: the time estimate for the ticket

  * if a ticket has a start time and a time estimate, and that timespan is

    close to the current date (between a couple weeks in the past and a couple

    months in the future), it will get drawn onto the timeline

* ``components``: arbitrary list of components

  * if a ticket has no listed components, it will get highlighted as requiring

    attention

* ``labels``: arbitrary list of labels

  * if a ticket has no listed labels, it will get highlighted as requiring

    attention

  * if the label matches your configured "OKR Label" setting (default:

    ``okr``), ensure it appears on the timeline page

* ``votes``: the collection of user votes on the issue

.. _create a Jira API token: https://id.atlassian.com/manage-profile/security/api-tokens