Skip to main content

Track @progress comments across source code files

Project description

progtrack

📊 Track @progress comments in your codebase to monitor development progress.

progtrack is a simple CLI tool that scans your source code files for @progress annotations and summarizes the implementation status across files. It helps you track how much of your code is complete, in progress, or untracked.

✨ Features

  • Detects @progress annotations like:
    # @progress 80%: "needs testing"
    # @progress 80%: 'needs testing'
    # @progress 0.5
    # @progress done
    
  • Supports multiple file types: .py, .js, .ts, .vue, .html (customisable)
  • Generates CLI summary and optional CSV report
  • Reports average completion rate
  • Ignores unmarked files by default
  • Configurable exclude folders (e.g. node_modules)

🧰 Installation

pip install progtrack

🚀 Usage

# Basic
progress
progress .
# Output to CSV
progress --csv my_report.csv
# Custom file types
progress --ext .py,.vue,.ts
# Exclude folders
progress --exclude node_modules,dist,build

📦 Example Output

file                 progress    note
------------------  ----------  ----------------------
main.py               1.00
api/data.py           0.80       needs tests
auth/login.vue        0.50       basic done

📊 Summary
-----------
Marked files: 3
Completed files: 1
Average progress: 76.67%
Unmarked files: 2

🪪 License

MIT © 2025

🤖 GitHub / PyPI

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

progtrack-0.1.4.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

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

progtrack-0.1.4-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file progtrack-0.1.4.tar.gz.

File metadata

  • Download URL: progtrack-0.1.4.tar.gz
  • Upload date:
  • Size: 3.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for progtrack-0.1.4.tar.gz
Algorithm Hash digest
SHA256 33c86c05b2ee1f2bd8caff2ef7e421282cd7bd907458408518760517a04c2984
MD5 73d5a41093f6d9ed0de7416a2ce0370c
BLAKE2b-256 56d57ce737a96601a8361d78446d1a14971de392026c4672425cb2fc35b58493

See more details on using hashes here.

File details

Details for the file progtrack-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: progtrack-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for progtrack-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 161430986057bb662d7b7797a48d5a1844151b342eb625f68e4c43b9925399e7
MD5 a0825f14fce421b683a35cd127a51bc9
BLAKE2b-256 ae068df9a5a2136177c1b5a971e84849d5d188de0a811d9b7be624d710e53202

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