Contents
- 📖 Description
- 🚀 Quick start
- ✨ Features
- 📦 Installation
- 📲 Usage
- ⚙ Options
- 💻 Development
- 👥 Contributing
📖 Description
💻 Windows, Linux and Mac compatible. 💻
A Python script to track time spent on various projects. This script allows you to start, stop, and monitor time tracking for different projects, as well as output data to files.
It is very lightweight since it doesnt have to be running in the background.
This script is going to help you track:
- Total time spent on different projects
- Work sessions information
- Time spent on each session
🚀 Quick start
pipx install hourtrack
hourtrack start myProject
✨ Features
- Supports multiple projects: Track time for multiple projects.
- Start/Stop tracking: Start and stop tracking time for a project.
- List projects: List all projects being tracked.
- Delete project: Delete a project and all its data.
- Reset project: Reset a project's data.
- Export data: Export data to a
.txtfile. - ...
📦 Installation
From PyPI
pipx install hourtrack
pipx is optional but recommended, you can use pip instead.
Optional installation alternative
git clone https://github.com/P-ict0/HourTrack.git
cd HourTrack
pipx install . # You can also use `pip`
📲 Usage
For help:
hourtrack --help
(Optional) Create a project: Create a project to start tracking time. (This is not necessary, as the project will be created when you start tracking time for it.)
hourtrack create <project>
Start tracking: Start tracking session for a project. If the project does not exist, it will be created.
hourtrack start <project>
Stop tracking: Stop current session for a project, saving the time spent. With option to delete all projects.
hourtrack stop <project|--all>
Reset project: Reset a project's data. With option to reset all projects
hourtrack reset <project|--all>
Rename project: Rename a project.
hourtrack rename <oldProject> [<newProject>]
Delete project: Delete a project and all its data. With option to delete all projects.
hourtrack delete <project|--all>
List projects: List all/active projects.
hourtrack list <all|active> [--format <smart|full|short|hours>]
Project Info: Show the status of a specific project or show current active session. With option to output to a file.
# Project status
hourtrack info <project> [--format <smart|full|short|hours>] [-o <outputPath>]
# Active session
hourtrack info [--format <smart|full|short|hours>]
⚙ Options
| Command | Requirement | Default | Description |
|---|---|---|---|
hourtrack --help |
None | None | For help |
hourtrack create <project> |
Project name | None | Create a new empty project. |
hourtrack start <project> |
Project name | None | Start tracking session for a project. If the project does not exist, it will be created. |
hourtrack stop <project|--all> |
Project name or -a/--all flag |
None | Stop current session for a project, saving the time spent. With option to stop all projects |
hourtrack reset <project|--all> |
Project name or -a/--all flag |
None | Reset a project's data. With option to reset all projects |
hourtrack rename <oldProject> [<newProject>] |
Old project name | None | Renames an already existing project |
hourtrack delete <project|--all> |
Project name or -a/--all flag |
None | Delete a project and all its data. With option to delete all projects |
hourtrack list <all|active> [--format <smart|full|short|hours>] |
format smart |
None | List all/active projects. |
hourtrack info [<project>] [--format <smart|full|short|hours>] [-o <outputPath>] |
format smart |
None | Show the info of a specific project or show current active session if project is not specified. With option to output to a file. |
💻 Development
git clone https://github.com/P-ict0/HourTrack.git
cd HourTrack
python -m venv venv
pip install -r requirements.txt
source venv/bin/activate # Windows: .\venv\Scripts\activate.ps1
# Run the script
python src/hourtrack.py --help
👥 Contributing
Contributions are welcome! Please fork the repository and submit a pull request with your suggested changes.
1 maintainer
Release files for hourtrack 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| hourtrack-1.4.0.tar.gz | 48.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| hourtrack-1.4.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 83.8 kB
Release files / hourtrack-1.4.0.tar.gz
| Download URL | hourtrack-1.4.0.tar.gz |
|---|---|
| Size | 48.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a9871e69be49c1640053b976b93be6097c112bfadb430a1f784dd73af9c0a148
|
|
BLAKE2b-256 checksum How to use checksums |
de90c0bb55e513ecde5065d1751a581c540f0f4e67a285d95cf969ae556b79bd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
Release files / hourtrack-1.4.0-py3-none-any.whl
| Download URL | hourtrack-1.4.0-py3-none-any.whl |
|---|---|
| Size | 35.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d3e826d1e49a177ee47d270a2fd5650732007d0dc064150317494573370f4c4c
|
|
BLAKE2b-256 checksum How to use checksums |
fdb78a646f9ac415c3882402cb4baccb5d6806d5245a97b670ca07050790da17
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/5.1.1 CPython/3.9.19
|
