braglog 0.2.0

A concise command-line tool for quickly logging daily tasks and milestones, ideal for personal and professional record-keeping.

braglog

Easily log and manage daily work achievements to boost transparency and productivity 🌟

Background

I got this idea from here. My main goal is to use this project as a playground. I want to record a series of videos where we collaboratively work on solving an issue by developing a new feature each time.

To-Do List

• Develop the show sub-command using a test-driven development (TDD) approach with options for --contains, --from, --until, and --on.
• Publish the app using uv.
• Introduce the Ruff code formatter.
• Utilize pre-commit hooks.
• Add GitHub Actions to run test cases and check code formatting.
• Set up GitHub Actions to upload the latest version to PyPI.
• Implement the export functionality.

Installation

Install this tool using pip:

pip install braglog

Or using pipx:

pipx install braglog

Or using uv:

uv tool install braglog

Usage

For help, run:

braglog --help

You can also use:

python -m braglog --help

Adding Work Achievements

To log today's achievement:

braglog Fixed the authentication bug in login module

To log an achievement for a specific date:

braglog --date 2025-03-19 "Completed code review for PR #123"

To see the location of your logs file:

braglog logs-path

Viewing Work Achievements

View all entries or filter them:

# Show all entries
braglog show

# Filter by text
braglog show --contains "bug fix"

# Show entries for specific date
braglog show --on "2025-03-19"

# Quick manager meeting prep - show last 2 weeks of achievements
braglog show -s "2 weeks ago"

[!NOTE] --on cannot be used with --since or --until

Delete Achievements

For deleting records, simply use --delete:

braglog show --on today --delete

Contributing

To contribute to this tool, first checkout the code. Then create a new virtual environment:

cd braglog
python -m venv .venv
source .venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[dev]'

Or if you are using uv:

uv sync --extra dev

To run the tests:

uv run pytest .

To help ensure consistent code quality that follows our guidelines, pre-commit may be used. We have git hooks defined which will execute before commit. To install the hooks:

pre-commit install