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.3.tar.gz (3.7 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.3-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: progtrack-0.1.3.tar.gz
  • Upload date:
  • Size: 3.7 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.3.tar.gz
Algorithm Hash digest
SHA256 026c6dad5d6334a2631981e9eb4cb1f30ae5803cb47cefa78c9ed613ead03455
MD5 5d456fdd36a5c66968690e9fe8e4fb72
BLAKE2b-256 676e313814f19cc75b5a2ca895c366f8fc7d415b2bee06e69cf93180668d0bda

See more details on using hashes here.

File details

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

File metadata

  • Download URL: progtrack-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 4.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5514498d12d7f0a27da88a4e407a63281862cacaec2442452dad3bd4d1f7a1c7
MD5 4af94f142184ac3daffff5d24a8f2564
BLAKE2b-256 577e5a568289f48a2ee18986e88faaca2f892834b0b453de532cc6665782ef56

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