clockman


Nameclockman JSON
Version 0.1.0 PyPI version JSON
download
home_pageNone
SummaryTerminal-based time tracking for developers
upload_time2025-08-01 18:31:19
maintainerNone
docs_urlNone
authorNone
requires_python>=3.11
licenseMIT
keywords cli productivity terminal time-tracking
VCS
bugtrack_url
requirements typer rich platformdirs pydantic
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TrackIt

> Terminal-based time tracking for developers who value privacy and simplicity

[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

TrackIt is a privacy-focused, offline-first time tracking CLI designed for developers who want to track their work without sacrificing performance or privacy.

## Features

- **Privacy First** - All data stays local in SQLite database
- **Lightning Fast** - Zero-latency offline operation
- **Smart Tagging** - Organize tasks with custom tags
- **Beautiful Output** - Rich terminal interface with colors and formatting
- **Detailed Logging** - Comprehensive time tracking and reporting
- **Type Safe** - Built with modern Python and full type hints
- **Developer Friendly** - Clean CLI interface designed for technical workflows

## Quick Start

### Installation

```bash
pip install trackit
```

### Basic Usage

```bash
# Start tracking time
tracker start "Fix authentication bug" --tag backend --tag bug

# Check current status
tracker status

# Stop current session
tracker stop

# View your work log
tracker log
```

## Commands

### `tracker start <description>`

Start a new time tracking session.

```bash
# Basic usage
tracker start "Working on API endpoints"

# With tags for better organization
tracker start "Frontend refactoring" --tag frontend --tag refactor

# Multiple tags
tracker start "Database migration" --tag db --tag migration --tag urgent
```

### `tracker stop`

Stop the current tracking session.

```bash
tracker stop
```

### `tracker status`

Display current tracking status.

```bash
tracker status
# Output: Currently tracking: "Fix authentication bug" (2h 34m) [backend, bug]
```

### `tracker log`

View your complete work history.

```bash
tracker log
# Shows formatted table with all sessions, durations, and tags
```

### `tracker version`

Display version information.

```bash
tracker version
```

## Usage Examples

### Daily Development Workflow

```bash
# Morning standup prep
tracker start "Review PRs and plan day" --tag planning

# Main development work
tracker start "Implement user authentication" --tag feature --tag auth

# Bug fixing session
tracker start "Fix CSS layout issues" --tag bugfix --tag frontend

# Code review
tracker start "Review team PRs" --tag review

# End of day
tracker log  # Review what you accomplished
```

### Project Organization with Tags

```bash
# Frontend work
tracker start "Component refactoring" --tag frontend --tag react

# Backend API development
tracker start "REST API endpoints" --tag backend --tag api

# DevOps and deployment
tracker start "CI/CD pipeline setup" --tag devops --tag deployment

# Testing
tracker start "Unit test coverage" --tag testing --tag quality
```

## Configuration

TrackIt stores all data locally in your system's application data directory:

- **Linux**: `~/.local/share/trackit/`
- **macOS**: `~/Library/Application Support/trackit/`
- **Windows**: `%APPDATA%\trackit\`

The SQLite database (`tracking.db`) contains all your time tracking data.

## Architecture

TrackIt is built with a clean, modular architecture:

```bash
trackit/
    cli/           # Command-line interface
    core/          # Core business logic
    db/            # Database operations
    utils/         # Utility functions
    tests/         # Test suite
```

**Key Technologies:**

- **Typer** - Modern CLI framework
- **Rich** - Beautiful terminal formatting
- **Pydantic** - Data validation and serialization
- **SQLite** - Local data storage
- **Pytest** - Testing framework

## Contributing

We welcome contributions Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on:

- Code style and standards
- Testing requirements
- Pull request process
- Issue reporting

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

Built with ❤️ by the Theany Team for developers who value privacy and productivity.

---

**Questions or issues?** [Open an issue](https://github.com/theany-org/trackit/issues) on GitHub.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "clockman",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "cli, productivity, terminal, time-tracking",
    "author": null,
    "author_email": "Theany Team <epicrr001@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/8d/df/715a9e09ca8f579604f62122e790909afb92e19fde95683a745f3ddea0e3/clockman-0.1.0.tar.gz",
    "platform": null,
    "description": "# TrackIt\n\n> Terminal-based time tracking for developers who value privacy and simplicity\n\n[![Python 3.11+](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/downloads/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nTrackIt is a privacy-focused, offline-first time tracking CLI designed for developers who want to track their work without sacrificing performance or privacy.\n\n## Features\n\n- **Privacy First** - All data stays local in SQLite database\n- **Lightning Fast** - Zero-latency offline operation\n- **Smart Tagging** - Organize tasks with custom tags\n- **Beautiful Output** - Rich terminal interface with colors and formatting\n- **Detailed Logging** - Comprehensive time tracking and reporting\n- **Type Safe** - Built with modern Python and full type hints\n- **Developer Friendly** - Clean CLI interface designed for technical workflows\n\n## Quick Start\n\n### Installation\n\n```bash\npip install trackit\n```\n\n### Basic Usage\n\n```bash\n# Start tracking time\ntracker start \"Fix authentication bug\" --tag backend --tag bug\n\n# Check current status\ntracker status\n\n# Stop current session\ntracker stop\n\n# View your work log\ntracker log\n```\n\n## Commands\n\n### `tracker start <description>`\n\nStart a new time tracking session.\n\n```bash\n# Basic usage\ntracker start \"Working on API endpoints\"\n\n# With tags for better organization\ntracker start \"Frontend refactoring\" --tag frontend --tag refactor\n\n# Multiple tags\ntracker start \"Database migration\" --tag db --tag migration --tag urgent\n```\n\n### `tracker stop`\n\nStop the current tracking session.\n\n```bash\ntracker stop\n```\n\n### `tracker status`\n\nDisplay current tracking status.\n\n```bash\ntracker status\n# Output: Currently tracking: \"Fix authentication bug\" (2h 34m) [backend, bug]\n```\n\n### `tracker log`\n\nView your complete work history.\n\n```bash\ntracker log\n# Shows formatted table with all sessions, durations, and tags\n```\n\n### `tracker version`\n\nDisplay version information.\n\n```bash\ntracker version\n```\n\n## Usage Examples\n\n### Daily Development Workflow\n\n```bash\n# Morning standup prep\ntracker start \"Review PRs and plan day\" --tag planning\n\n# Main development work\ntracker start \"Implement user authentication\" --tag feature --tag auth\n\n# Bug fixing session\ntracker start \"Fix CSS layout issues\" --tag bugfix --tag frontend\n\n# Code review\ntracker start \"Review team PRs\" --tag review\n\n# End of day\ntracker log  # Review what you accomplished\n```\n\n### Project Organization with Tags\n\n```bash\n# Frontend work\ntracker start \"Component refactoring\" --tag frontend --tag react\n\n# Backend API development\ntracker start \"REST API endpoints\" --tag backend --tag api\n\n# DevOps and deployment\ntracker start \"CI/CD pipeline setup\" --tag devops --tag deployment\n\n# Testing\ntracker start \"Unit test coverage\" --tag testing --tag quality\n```\n\n## Configuration\n\nTrackIt stores all data locally in your system's application data directory:\n\n- **Linux**: `~/.local/share/trackit/`\n- **macOS**: `~/Library/Application Support/trackit/`\n- **Windows**: `%APPDATA%\\trackit\\`\n\nThe SQLite database (`tracking.db`) contains all your time tracking data.\n\n## Architecture\n\nTrackIt is built with a clean, modular architecture:\n\n```bash\ntrackit/\n    cli/           # Command-line interface\n    core/          # Core business logic\n    db/            # Database operations\n    utils/         # Utility functions\n    tests/         # Test suite\n```\n\n**Key Technologies:**\n\n- **Typer** - Modern CLI framework\n- **Rich** - Beautiful terminal formatting\n- **Pydantic** - Data validation and serialization\n- **SQLite** - Local data storage\n- **Pytest** - Testing framework\n\n## Contributing\n\nWe welcome contributions Please see our [CONTRIBUTING.md](CONTRIBUTING.md) for details on:\n\n- Code style and standards\n- Testing requirements\n- Pull request process\n- Issue reporting\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Acknowledgments\n\nBuilt with \u2764\ufe0f by the Theany Team for developers who value privacy and productivity.\n\n---\n\n**Questions or issues?** [Open an issue](https://github.com/theany-org/trackit/issues) on GitHub.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Terminal-based time tracking for developers",
    "version": "0.1.0",
    "project_urls": {
        "Homepage": "https://github.com/theany-org/trackit",
        "Issues": "https://github.com/theany-org/trackit/issues",
        "Repository": "https://github.com/theany-org/trackit.git"
    },
    "split_keywords": [
        "cli",
        " productivity",
        " terminal",
        " time-tracking"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b6938b77f498a77ae00d104a9cb079eaf23fb976439204493653daa46ee0880b",
                "md5": "272d254bce9f521340274efdf82f468c",
                "sha256": "7738ac9efdc3ea4a905f4ff86021f65c6258aae217b45e53b9dc3ebb9965dbeb"
            },
            "downloads": -1,
            "filename": "clockman-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "272d254bce9f521340274efdf82f468c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 51572,
            "upload_time": "2025-08-01T18:31:18",
            "upload_time_iso_8601": "2025-08-01T18:31:18.091685Z",
            "url": "https://files.pythonhosted.org/packages/b6/93/8b77f498a77ae00d104a9cb079eaf23fb976439204493653daa46ee0880b/clockman-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8ddf715a9e09ca8f579604f62122e790909afb92e19fde95683a745f3ddea0e3",
                "md5": "d9d8c4d03efa8611322cc771e9bc5a3c",
                "sha256": "b19f2bec007c456988ee56cc6a70814e4f73196a8036f977b0c909d52e8ab22e"
            },
            "downloads": -1,
            "filename": "clockman-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d9d8c4d03efa8611322cc771e9bc5a3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 55931,
            "upload_time": "2025-08-01T18:31:19",
            "upload_time_iso_8601": "2025-08-01T18:31:19.434670Z",
            "url": "https://files.pythonhosted.org/packages/8d/df/715a9e09ca8f579604f62122e790909afb92e19fde95683a745f3ddea0e3/clockman-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-01 18:31:19",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "theany-org",
    "github_project": "trackit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "typer",
            "specs": [
                [
                    ">=",
                    "0.9.0"
                ]
            ]
        },
        {
            "name": "rich",
            "specs": [
                [
                    ">=",
                    "13.0.0"
                ]
            ]
        },
        {
            "name": "platformdirs",
            "specs": [
                [
                    ">=",
                    "4.0.0"
                ]
            ]
        },
        {
            "name": "pydantic",
            "specs": [
                [
                    ">=",
                    "2.5.0"
                ]
            ]
        }
    ],
    "lcname": "clockman"
}
        
Elapsed time: 2.18321s