Skip to main content

A CLI and web-based tool for tracking daily work activities and generating reports

Project description

FastRep

A powerful CLI and web-based tool for tracking daily work activities and generating professional reports.

PyPI version License: MIT

Features

  • Easy Logging: Quickly log your daily work activities with project names and descriptions
  • Automatic Reports: Generate weekly, bi-weekly, and monthly reports instantly
  • Dual Interface: Use either the command-line interface or the professional web UI
  • SQLite Database: All data stored locally in a lightweight SQLite database
  • Project Tracking: Automatically organize logs by project
  • Flexible Dating: Log entries for any date, not just today
  • Easy Search: View and filter logs by date range
  • Data Management: Delete individual entries or clear entire database
  • Dark/Light Theme: Choose your preferred theme or sync with system settings
  • App Mode: Launches as a standalone application window for a cleaner experience
  • AI Summarization: Automatically summarizes extensive monthly logs into concise bullet points using Cline
  • Customizable Templates: Choose from multiple report formats (Classic, Modern, Professional, etc.) to suit your needs
  • Smart Reminders: Configure daily desktop notifications to remind you to log your work

Screenshots

FastRep Dashboard     FastRep Reports

Installation

From PyPI (Recommended)

pip install fastrep

From Source

git clone https://github.com/hissain/fastrep.git
cd fastrep
pip install -e .

Quick Start

Command Line Interface

# Add a work log entry
fastrep log -p "Project Alpha" -d "Implemented user authentication"

# Add a log for a specific date
fastrep log -p "Project Beta" -d "Fixed bug #123" --date 2024-11-15

# View weekly report
fastrep view --mode weekly

# View bi-weekly report
fastrep view --mode biweekly

# View monthly report
fastrep view --mode monthly

# List all entries
fastrep list

# View all projects
fastrep projects

# Delete a specific entry
fastrep delete --id 5

# Clear all data (with confirmation)
fastrep clear

Web Interface

Launch the web UI:

fastrep-ui

The web interface will automatically open in your default browser at http://127.0.0.1:5000.

You can also specify a custom port:

fastrep-ui --port 8080
# or
fastrep-ui -p 8080

For debugging AI summarization issues, use verbose mode:

fastrep-ui --verbose

Usage Examples

Daily Workflow

# Morning: Log yesterday's work
fastrep log -p "API Development" -d "Completed endpoint for user profiles" --date 2024-11-20

# End of day: Log today's work
fastrep log -p "API Development" -d "Started work on authentication middleware"
fastrep log -p "Documentation" -d "Updated API documentation"

# Friday: Generate weekly report
fastrep view --mode weekly

Report Output Example

Report Period: 11/16 - 11/22
============================================================

Project: API Development
------------------------------------------------------------
  * 11/21 - Started work on authentication middleware
  * 11/20 - Completed endpoint for user profiles
  * 11/18 - Fixed performance issues in database queries

Project: Documentation
------------------------------------------------------------
  * 11/21 - Updated API documentation
  * 11/19 - Created user guide for new features

CLI Commands Reference

fastrep log

Add a new work log entry.

Options:

  • -p, --project TEXT: Project name (optional, defaults to "Misc")
  • -d, --description TEXT: Work description (required)
  • -dt, --date TEXT: Date in YYYY-MM-DD format (optional, defaults to today)

fastrep view

View logs and generate reports.

Options:

  • -m, --mode [weekly|biweekly|monthly]: Report period (default: weekly)
  • -s, --start TEXT: Custom start date (YYYY-MM-DD)
  • -e, --end TEXT: Custom end date (YYYY-MM-DD)

fastrep list

List all log entries with their IDs.

fastrep projects

List all unique projects.

fastrep delete

Delete a specific log entry.

Options:

  • -i, --id INTEGER: Log entry ID to delete (required)
  • -y, --confirm: Skip confirmation prompt

fastrep clear

Clear all log entries from the database.

Options:

  • -y, --confirm: Skip confirmation prompt

Web UI Features

The web interface provides:

  1. Dashboard: Add new logs with autocomplete for project names
  2. Recent Logs Table: View, edit, and delete entries
  3. Report Generation: One-click weekly, bi-weekly, and monthly reports
  4. Copy to Clipboard: Easy report copying for emails/documents
  5. AI Summarization: Intelligent summarization for monthly reports (requires Cline CLI)
  6. Custom Instructions: Provide specific guidance to the AI for tailored report summaries
  7. Report Templates: Select from various visual styles (Classic, Bold, Modern, Professional, Compact) with live preview
  8. Theme Support: Toggle between Light, Dark, and System themes
  9. Daily Reminders: Set up custom notifications to log your work
  10. Settings: Comprehensive configuration for all features
  11. App Mode: Opens in a dedicated window without browser clutter
  12. Compact Design: Optimized form layout for quick entry

Database Location

Logs are stored in: ~/.fastrep/fastrep.db

Both CLI and web UI use the same database, so your data is always in sync.

Development

Setup Development Environment

git clone https://github.com/hissain/fastrep.git
cd fastrep
pip install -e .

Project Structure

fastrep/
├── fastrep/
│   ├── __init__.py
│   ├── cli.py              # CLI commands
│   ├── database.py         # Database operations
│   ├── models.py           # Data models
│   ├── report_generator.py # Report generation logic
│   └── ui/
│       ├── app.py          # Flask application
│       ├── templates/      # HTML templates
│       └── static/         # CSS files
├── tests/
├── setup.py
└── README.md

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Md. Sazzad Hissain Khan

Acknowledgments

  • Built with Click for CLI
  • Web UI powered by Flask
  • Database management with SQLite

Support

If you encounter any issues or have questions:

  • Open an issue on GitHub
  • Check existing issues for solutions

Star ⭐ this repository if you find it helpful!

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

fastrep-2.0.6.tar.gz (370.9 kB view details)

Uploaded Source

Built Distribution

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

fastrep-2.0.6-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file fastrep-2.0.6.tar.gz.

File metadata

  • Download URL: fastrep-2.0.6.tar.gz
  • Upload date:
  • Size: 370.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for fastrep-2.0.6.tar.gz
Algorithm Hash digest
SHA256 dac8e9245f3681f67cd0180eea98657d74fbd1e0f085a983802bd8818166dca9
MD5 19a969c231ebf528f0d5a214d4a6948d
BLAKE2b-256 f6667f586e648f85511cb3c8751d4d1ccdeea2e73f52ed176c299da86b110c0d

See more details on using hashes here.

File details

Details for the file fastrep-2.0.6-py3-none-any.whl.

File metadata

  • Download URL: fastrep-2.0.6-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for fastrep-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 73c3a9aebe888598a1cb0f3783938e1f79ce2e3749c8efa4a533d9b7f6659a98
MD5 d06ed1a655c60e005f7d80a97f95e74d
BLAKE2b-256 ac9eb9b8256255196c8d289e053a90e2cca8ac70b7b46c01952b3c0dd88e1670

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