Skip to main content

AI-native development progress dashboard — turn your git history into a beautiful narrative page.

Project description

towow-progress

Turn your git history into a beautiful, artistic progress page. Not a boring dashboard — a narrative that tells your project's story.

MIT License

Quick Start

pip install towow-progress
cd your-repo
towow-progress init        # auto-detect modules, create config
towow-progress generate    # build docs/progress.html
open docs/progress.html    # done!

Let Your AI Set It Up

Paste this to Claude, ChatGPT, or any coding AI:

Install towow-progress, run towow-progress init on this repo, then customize .towow-progress.json — set a good title, subtitle, and adjust module names to be human-readable. Then run towow-progress generate and open the result.

Your AI will analyze your repo structure and configure everything.

What You Get

  • Hero section — total commits, lines changed, active days, longest streak
  • Live indicator — latest commit with relative time ("3m ago")
  • Scrollable timeline — daily commit activity with peak highlights
  • Module trends — stacked area chart showing strategic focus shifts
  • Distribution — horizontal bar chart of code by module
  • Weekly velocity — line chart with acceleration/deceleration analysis
  • Changelog — expandable recent commits with type badges, file counts, diffs

Single self-contained HTML file. Works offline. Deploy anywhere.

Configuration

towow-progress init creates .towow-progress.json:

{
  "title": "My Project Progress",
  "subtitle": "Built by a team of 3 over 120 days",
  "lang": "en",
  "modules": {
    "src": "Core Engine",
    "api": "API Layer",
    "web": "Frontend",
    "tests": "Test Suite",
    "docs": "Documentation"
  },
  "colors": {
    "src": "#1D4ED8",
    "api": "#059669",
    "web": "#EA580C",
    "tests": "#7C3AED",
    "docs": "#0891B2"
  },
  "output": "docs/progress.html",
  "accent_color": "#1D4ED8",
  "accent_secondary": "#EA580C",
  "background": "#F7F4F0",
  "font_family": "",
  "branding": true
}

What you can customize

Field What it does Example
title Big hero title "Acme Engine"
subtitle Line under the title "3 engineers · 200 days"
modules Map directory prefixes to display names {"src": "Core"}
colors Hex color per module {"src": "#1D4ED8"}
accent_color Primary brand color (borders, links, charts) "#8B5CF6" (purple)
accent_secondary Highlight color (peaks, badges) "#F59E0B" (amber)
background Page background "#FAFAF9" (stone)
font_family Custom font stack "'JetBrains Mono', monospace"
output Where to write the HTML "public/progress.html"
branding Show "Powered by Towow" footer true / false

Color presets

Default (warm ivory + blue)

{ "accent_color": "#1D4ED8", "accent_secondary": "#EA580C", "background": "#F7F4F0" }

Dark academia

{ "accent_color": "#78350F", "accent_secondary": "#B45309", "background": "#FEFCE8" }

Cyberpunk

{ "accent_color": "#7C3AED", "accent_secondary": "#EC4899", "background": "#FAF5FF" }

Forest

{ "accent_color": "#065F46", "accent_secondary": "#D97706", "background": "#F0FDF4" }

Auto-Update with GitHub Actions

towow-progress setup-ci

This creates .github/workflows/towow-progress.yml. On every push to main, it regenerates and commits the HTML.

Deploy to GitHub Pages:

  1. Run towow-progress setup-ci
  2. Go to repo Settings → Pages → Source: Deploy from a branch → Branch: main, folder: /docs
  3. Push. Your progress page is live at https://username.github.io/repo/progress.html

How It Works

  1. Scans git historygit log --numstat to get per-file additions/deletions
  2. Classifies files — maps file paths to modules using your config
  3. Computes analytics — daily/weekly/monthly aggregations, velocity, streaks
  4. Renders HTML — single file with inline CSS + Chart.js from CDN

No database. No server. No API keys. Just git + Python.


Powered by Towow — AI-native collaboration protocol

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

towow_progress-0.1.0.tar.gz (14.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

towow_progress-0.1.0-py3-none-any.whl (16.1 kB view details)

Uploaded Python 3

File details

Details for the file towow_progress-0.1.0.tar.gz.

File metadata

  • Download URL: towow_progress-0.1.0.tar.gz
  • Upload date:
  • Size: 14.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for towow_progress-0.1.0.tar.gz
Algorithm Hash digest
SHA256 28b000bfe1e76b3ceebc2dfbd07fe228f739ffed98e6ee120cd10a48cb006fe5
MD5 a50bac8aa1a7964b3e4533c5a5afe010
BLAKE2b-256 83e2b2132877a60fe3adef08090442952022c437262be4b3af277f9f3bb17543

See more details on using hashes here.

File details

Details for the file towow_progress-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: towow_progress-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for towow_progress-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 62b85a7fdc4c56052e39b0374e46f91d542228c3830db907582cc832ebbf76eb
MD5 6f1b212a05b257de9933869eaf1920a7
BLAKE2b-256 8f5b1bafdaf8d827b41fdf3967c10cb0c4a49abd0c0add1cb570b4919b60c533

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page