A tool to extract metrics from agile tools such as Jira. It is heavilly influenced by the work of Troy Magennis (https://www.focusedobjective.com/)
Currently the following sources of information are supported:
Requires Python 3.6 or later.
Install Python 3 and the pip package manager.
If you're using Windows, install Python from Anaconda distribution (https://www.anaconda.com/products/individual). This will install some essential packages that fail to install via the standard python distribution. No guarantees that it will work well in Windows!
Then run to install required modules:
$ pip install -r requirements.txt Caveat: if you have both python and python3 install you will need to run pip3 instead of pip
Two major configuration files exist, one for configuring logging (log_config.yml) and another for the app main configuration (config.yml) Also for each project/team a config file needs to be created and stored in the directory configured in config.yml.
Please check conf/ directory with several examples for each case:
This file provide basic needed information: config_dir: directory where configuration files for each project are stored cache_dir: the directory where cache files are stored (needs yet to be implemented) debug: run application in debug mode or not (applicable for the web interface). Could be set to true or false
Change this file to your needs. By default it writes to /tmp/seshat.log
Sample files for each type of project have been provided. You can just copy them and rename it to .yml adding your own data The application can support multiple files/projects. If you add several files, you will be able to select which one to be used in the "projects" menu. This menu will only appear if you have more than one *.yml file.
One important note about jira passwords. Jira cloud version no longer support passwords and you need to create an API token instead and then copy&paste it to the password field. You can find more information about how to create API tokens here: https://confluence.atlassian.com/cloud/api-tokens-938839638.html
If using oauth authentication (more used for jira server) you will need to create your own certificates for the application and create an application link in you Jira instance. You can find more information about it here (Step 1): https://developer.atlassian.com/server/jira/platform/oauth/
To do the oauth dance and get the oauth token you can you can use the python jira-oauth packaget: https://pypi.org/project/jira-oauth/
Then use this to configure your access following the oauth example in conf/ directory
You need to get a trello API key and secret Check here for more information: https://trello.com/app-key
(in the future oauth support will be provided)
You need to get a Clubouse API key
Only project issues are supported for now. You will need to get a Personal access token: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
Configure here the workflow of your team/project. The Worklow provided in the example files are only examples and you will need to customized them to your needs.
To configure the workflow make sure that the name in the right is the same as the one in the left. For example
To Do: To Do
Done: DoneThe reason for this is that I plan in the future to support mapping several states to the same step.
There is a "special" state called "Created". This one will show the date the card was created. In Jira, use this "Created" instead of the first status.
To run the application just type
$python seshat.py (or just ./seshat.py in unix based OS).
After loading the data and starting with success, use your browser of choice and access http://localhost:8050/
To run the application in a server and access it from the outside, install a WSGI server (for example gunicorn) and don't forget to bind it to the public address.
For example:
$ gunicorn --bind 0.0.0.0 seshat:serverI'm not great with names in one hand and in another I would prefer to have something more interesting than "python agile metrics" or similar. So I looked for a name of a god that would make sense and found this in wikipedia:
Seshat, under various spellings, was the ancient Egyptian goddess of wisdom, knowledge, and writing.
She was seen as a scribe and record keeper, and her name means she who scrivens (i.e. she who is the scribe),
and is credited with inventing writing.