Skip to main content

Daily Standup Auto-Generator from git commits

Project description

Standup-CLI: The Daily Standup Auto-Generator

Standup-CLI is a terminal tool that generates daily standup summaries from git commit history. It supports local repositories and public GitHub URLs, automatically categorizing your work into Features, Bug Fixes, and Maintenance.

🚀 Quick Start

Installation

Choose one of the following methods:

Option 1: From PyPI (Recommended)

pip install standup-cli
standup-cli

Option 2: From Homebrew (macOS)

brew tap prayagtushar/standup-cli
brew install standup-cli
standup-cli

Option 3: From GitHub

pip install git+https://github.com/prayagtushar/standup-cli.git
standup-cli

Option 4: Development Setup

git clone https://github.com/prayagtushar/standup-cli.git
cd standup-cli
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate
pip install -r requirements.txt
python main.py

🛠 Usage & Options

You can also bypass the prompts by providing arguments directly:

python main.py [OPTIONS]
Option Shorthand Description
--path -p Local folder path or public GitHub URL
--days -d Number of days to look back (default: 1)
--author -a Filter by author name (substring match)
--copy -c Automatically copy the summary to clipboard

Examples:

  • Scan a GitHub Repo: python main.py -p https://github.com/psf/requests -d 7
  • Scan Current Folder: python main.py (then press Enter for defaults)
  • Filter by Name & Copy: python main.py -a "Alice" -c

📊 Features

  • Interactive Mode: Guides you through setup if no arguments are provided.
  • Auto-Categorization: Uses commit message prefixes (feat, fix, docs, etc.) to group your updates.
  • GitHub Support: Clones public repositories to a temporary folder to scan them.
  • Rich Formatting: Beautiful tables and colored output for better readability.
  • Statistics: Provides a quick count of your activity by category.

📂 Project Structure

  • main.py: The entry point and CLI logic.
  • git_utils.py: Logic for cloning and reading git history.
  • parser.py: Logic for categorizing and formatting commit messages.
  • requirements.txt: Project dependencies.

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

standup_cli-0.1.0.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

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

standup_cli-0.1.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: standup_cli-0.1.0.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for standup_cli-0.1.0.tar.gz
Algorithm Hash digest
SHA256 a6a7699ec25192c85df03486638ceee3f89a78eccf93d6b00c1940f12000062f
MD5 9672542efa780ee747526b3fbfee5dd5
BLAKE2b-256 7bb9989295ef6a4635814040dbc6c4f0747eaff962014851a051fe7114f08fbf

See more details on using hashes here.

Provenance

The following attestation bundles were made for standup_cli-0.1.0.tar.gz:

Publisher: publish.yml on prayagtushar/standup-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

  • Download URL: standup_cli-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for standup_cli-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0eef0647da3da455e952ae8b6601222c6f6f0ae43b7c1762ed80404d9f25a125
MD5 ca52e2bd4ed017efb02f879431bf19db
BLAKE2b-256 3afd71b0fcd90df4e15f43e31a743f0cd3e54a70d2dfe5a4dd1b92e7641c0fff

See more details on using hashes here.

Provenance

The following attestation bundles were made for standup_cli-0.1.0-py3-none-any.whl:

Publisher: publish.yml on prayagtushar/standup-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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