taiga-stats

KO | EN

gitlite — search

#python #react #ai #typescript #rust #docker #macos #windows #kubernetes #vue #mcp #ios #openai #open-source

(★ 45)

Generate statistics from Taiga and produce burnup diagrams, CFDs, dependency graphs and more.

taiga-stats Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<!--
|￣￣￣￣￣￣￣￣￣￣￣|
| Don't edit 　　    |
| README.md directly!|
|＿＿＿＿＿＿＿＿＿＿＿|
(\__/) ||
(•ㅅ•) ||
/ 　 づ
It will be overwritten by bin/gen_docs.sh.

Instead:
1. edit README.md.in
2. run $ bin/gen_docs.sh
 -->
# Taiga Stats - Your Taiga Statistics Tool [![Post on X](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://x.com/intent/tweet?text=Scrum%20and%20Kanban%20masters;%20generate%20statistics%20from%20your%20Taiga.io%20projects%20with%20this%20python%20tool&url=https://github.com/erikw/taiga-stats&via=erik_westrup&hashtags=taiga,scrum,kanban,statistics)

[![PyPI version](https://badge.fury.io/py/taiga-stats.svg)](https://badge.fury.io/py/taiga-stats)
[![Downloads](https://pepy.tech/badge/taiga-stats)](https://pepy.tech/project/taiga-stats)
[![Documentation Status](https://readthedocs.org/projects/taiga-stats/badge/?version=latest)](https://taiga-stats.readthedocs.io/)
[![Supported Python versions](https://img.shields.io/pypi/pyversions/taiga-stats)](https://raw.githubusercontent.com/erikw/taiga-stats/main/)
[![CI](https://github.com/erikw/taiga-stats/actions/workflows/ci.yml/badge.svg)](https://github.com/erikw/taiga-stats/actions/workflows/ci.yml)
[![Lint](https://github.com/erikw/taiga-stats/actions/workflows/linter.yml/badge.svg)](https://github.com/erikw/taiga-stats/actions/workflows/linter.yml)
[![SLOC](https://sloc.xyz/github/erikw/taiga-stats?lower=true)](https://raw.githubusercontent.com/erikw/taiga-stats/main/)
[![Number of programming languages used](https://img.shields.io/github/languages/count/erikw/taiga-stats)](https://raw.githubusercontent.com/erikw/taiga-stats/main/)
[![Top programming languages used](https://img.shields.io/github/languages/top/erikw/taiga-stats)](https://raw.githubusercontent.com/erikw/taiga-stats/main/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html)
[![License](https://img.shields.io/pypi/l/taiga-stats)](https://github.com/erikw/taiga-stats/blob/main/LICENSE)
[![OSS Lifecycle](https://img.shields.io/osslifecycle/erikw/taiga-stats)](https://github.com/Netflix/osstracker)
[![Latest tag](https://img.shields.io/github/v/tag/erikw/taiga-stats)](https://github.com/erikw/taiga-stats/tags)

This is a script for all you Scrum||Kanban masters out there who use Taiga and are interested in visualizing progress and generating some automated statistics and graphs.

[Taiga](https://taiga.io/) is an open-source virtual Scrum and Kanban board that is popular for managing projects and work. We use a physical whiteboard at work, but I mirror the status of stories in Taiga so that I can collect some statistics and generate diagrams and graphs using this tool I wrote.

# Features

```console
$ taiga-stats --help
usage: taiga-stats [-h] [-v] [--url URL] [--auth-token AUTH_TOKEN]
                   {config_template,list_projects,list_us_statuses,burnup,store_daily,points_sum,cfd,deps_dot_nodes,deps_dot}
                   ...

Taiga statistic tool. Default values for many options can be set config file;
see the command 'config_template'.

positional arguments:
  {config_template,list_projects,list_us_statuses,burnup,store_daily,points_sum,cfd,deps_dot_nodes,deps_dot}
                        Commands. Run $(taiga-stats <command> -h) for more
                        info about a command.
    config_template     Generate a template configuration file.
    list_projects       List all found project IDs and names on the server
                        that you have access to read.
    list_us_statuses    List all the ID and names of User Story statuses.
    burnup              Print burn(up|down) statistics. Typically used for
                        entering in an Excel sheet or such that plots a
                        burnup.
    store_daily         Store the current state of a project on file so that
                        the CFD command can generate a diagram with this data.
    points_sum          Print out the sum of points in User Story statuses.
    cfd                 Generate a Cumulative Flow Diagram from stored data.
    deps_dot_nodes      Print User Story nodes in .dot file format.
    deps_dot            Print US in .dot file format with dependencies too!
                        Create a custom attribute for User Stories named
                        'Depends On' by going to Settings>Attributes>Custom
                        Fields. Then go to a User Story and put in a comma
                        separated list of stories that this story depends on
                        e.g. '#123,#456'.

options:
  -h, --help            show this help message and exit
  -v, --version         show program's version number and exit
  --url URL             URL to Taiga server.
  --auth-token AUTH_TOKEN
                        Authentication token. Instructions on how to get one
                        is found at
                        https://docs.taiga.io/api.html#_authentication

Support: please go to https://github.com/erikw/taiga-stats/issues
```

# Terminology

* *US* - User Story
* *CFD* - Cumulative Flow Diagram

## Cumulative Flow Diagram

From a [CFD](http://brodzinski.com/2013/07/cumulative-flow-diagram.html) a lot of interesting insights about your team's progress [can be found](http://paulklipp.com/images/Interpreting_a_Cumulative_Flow_Diagram.jpg). However, I'm not a fan of repetitive work like counting and entering numbers in an Excel sheet. This had to be automated! Therefore I deiced to write this script to save data on a daily basis with a cron job and a function for generating this diagram. This diagram can the be put on a TV visible in the hallways.

This is an example diagram generated from [mock data](https://github.com/erikw/taiga-stats/tree/main/sample_data/cfd_example.dat):

![Example CFD](https://raw.githubusercontent.com/erikw/taiga-stats/main/img/cfd_example.png)

Textual annotations can be put in the plot by manually editing the `.dat file`.

Also, a target date for the project deadline can be specified. Then a line will be drawn showing the ideal work pace towards this date, as seen below, where the target finish date is in week 46.

![Example CFD with ideal pace](https://raw.githubusercontent.com/erikw/taiga-stats/main/img/cfd_example_ideal_pace.png)

To save the data and generate the diagram each working day, I have this cron job:

```console
$ crontab -l | grep taiga
0 18 * * 1-5            $HOME/bin/taiga-stats-cron.sh
```

and the script `taiga-stats-cron.sh`:

```bash
#!/usr/bin/env sh

taiga-stats store_daily --tag some_feature_tag
taiga-stats cfd --tag some_feature_tag
```

## User Story Dependency Graph

Some stories require others to be completed before they can be started. I thought it would be handy if you could keep track of these dependencies in Taiga, but simply write for each US a list of other stories that this story depends on. Then from this information a [.dot file](https://github.com/erikw/taiga-stats/tree/main/sample_data/dependencies_example.dot) can be generated that should how you user stories depends on each other. This graph is very useful for work planning i.e. what to start with and how much parallelization is possible and at what stages.

![US Dependency Graph](https://raw.githubusercontent.com/erikw/taiga-stats/main/img/dependencies_example.png)

The stories that are marked as Done in Taiga have a green color in the graph.

### How to set up the dependency feature

First, create a new custom field in Taiga named `Depends On` under Settings > Attributes > Custom Fields:

![Custom Field](https://raw.githubusercontent.com/erikw/taiga-stats/main/img/taiga_custom_field.png)

Then go to your User Stories and enter some dependencies as demonstrated below.

![US dependency](https://raw.githubusercontent.com/erikw/taiga-stats/main/img/us_depends_on.png)

Then run the script and generate a PNG file.

```shell
taiga-stats deps_dot
dot -T png -o ./dependencies.png ./dependencies.dot
```

# Setup

## Installation

Make sure to use a supported Python version. See `project.requires-python` in [pyproject.toml](https://github.com/erikw/taiga-stats/blob/main/pyproject.toml).

```shell
pip install taiga-stats
taiga-stats -h
```

If you use [pipx](https://pypi.org/project/pipx/) to install, you must specify a supported and locally available Python version, like:

```shell
pipx install --python python3.11 taiga-stats
```

To use this tool, you need to supply

* `--url` to your taiga server e.g., `https://api.taiga.io/`
* `--auth-token` that you need to obtain according to the [official instructions](https://docs.taiga.io/api.html#_authentication).

It's recommended to put these 2 values in the below-described `taiga-stats.conf` file for easier usage of this tool!

## Config file

It is tedious to have to specify the server URL and the authentication token every time. Also, you typically work with one project at a time and would like to have default values for the project to use, and maybe which tag to filter on. You can generate a configuration file to set these default values.

```shell
taiga-stats config_template
mv ./taiga.conf.template ~/.taiga-stats.conf
vi ~/.taiga-stats.conf
```

# Development

* `uv` manages the project virtual environment in `.venv`, so you generally do not need to activate it manually. Use `uv run ...` for project commands.
* Reference for how to structure a Python project: <https://realpython.com/pypi-publish-python-package/>

## Setup from Git

* Clone this git
 ```shell
 git clone https://github.com/erikw/taiga-stats.git && cd $(basename "$_" .git)
 ```

* Install uv
 ```shell
 curl -LsSf https://astral.sh/uv/install.sh | sh
 ```

* Install project dependencies
 ```shell
 uv sync --all-groups
 ```

* Dependency management
 ```shell
 uv add <package>
 uv add --group dev <package>
 uv remove <package>
 uv lock --upgrade
 ```

* Now taiga-stats should work!
 ```shell
 uv run taiga-stats -h
 # or
 bin/taiga-stats.sh
 ```

* To install locally:
 ```shell
 uv build
 uv pip install dist/taiga_stats-*.whl
 ```

## Linting and Formatting

* Linting: Consider isort, flake8, and pylint as replaced by ruff.
* Formatting: Consider black as replaced by ruff.

```shell
uv run ruff check
uv run ruff format
```

## Documentation generation

```shell
uv run --group docs mkdocs serve
uv run --group docs mkdocs build
```

but `bin/gen_docs.sh` will take care of all that plus more!

# Releasing

```shell
bin/gen_docs.sh
vi CHANGELOG.md
uv version --bump minor && ver="v$(uv version --short)"
git commit -am "Bump version to $ver" && git tag "$ver" && git push --atomic origin main "$ver"
uv build
uv publish
```

taiga-stats

taiga-stats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

taiga-stats

taiga-stats Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README