Tag your time, get the insight - an open source time-tracker with an interactive user experience and powerful reporting.

• Website: https://timetagger.app
• Demo: https://timetagger.app/demo
• Docs: https://timetagger.readthedocs.io
• CLI tool: https://github.com/almarklein/timetagger_cli
• TimeTagger_VSCodeExtension (3d party)

TimeTagger is a web-based time-tracking solution that can run locally or on a server. It's aimed at individuals and freelancers, and has the following features:

• Intuitive UI based around an interactive timeline.
• Lightweight feel by use of tags rather than projects.
• Reporting in PDF and CSV.
• Set daily/weekly/monthly targets.
• Integrated Pomodoro method (experimental).
• Responsive: works well on small and large screens.
• Sync between devices.

The server runs on async Python using uvicorn and asgineer - which is fun and bloody fast. It uses SQLite via itemdb to store the data, making it easy to deploy. Alternatively, you can use PostgreSQL for more robust database functionality in multi-user environments.

The client is a mix of HTML, CSS, Markdown, and ... Python! PScript is used to compile the Python to JavaScript. This may be a bit idiosyncratic, but it's fun! Maybe I'll someday implement it in something that compiles down to Wasm :)

TimeTagger is implemented as a Python library that requires Python 3.6 or higher. The dependencies are listed in requirements.txt - these are installed automatically when you install TimeTagger with Pip.

# Install
pip install -U timetagger

# Run
python -m timetagger

If the server runs on your local machine, you can use single-user mode out-of-the-box.

Docker images are provided via the Github container registry, so you can use e.g. Docker-compose to easily host your own server.

There are two variants, one that runs the server as root inside the container and a nonroot variant that runs as user 1000:

• docker-compose.yml
• docker-compose.nonroot.yml

See this article for more information about self hosting.

If you want multiple users, or if the server is not on localhost, you may want to provide the server with user credentials using an environment variable or a command line arg (see the docs on config).

# Using command-line args
python -m timetagger --credentials=test:$2a$08$0CD1NFiIbancwWsu3se1v.RNR/b7YeZd71yg3cZ/3whGlyU6Iny5i

# Using environment variables
export TIMETAGGER_CREDENTIALS='test:$2a$08$0CD1NFiIbancwWsu3se1v.RNR/b7YeZd71yg3cZ/3whGlyU6Iny5i'
python -m timetagger

The credentials take the form ":", where the hash is a (salted) BCrypt hash of the password. You can generate credentials using e.g. https://timetagger.app/cred.

If you have a reverse proxy which already authenticates users (e.g. Authelia) and provides the username through a HTTP header, you can tell TimeTagger to use this information. To configure it there are three environment variables and command line arguments (see the docs on config).

# Using command-line args
python -m timetagger --proxy_auth_enabled=True --proxy_auth_trusted=127.0.0.1 --proxy_auth_header=X-Remote-User

# Using environment variables
export TIMETAGGER_PROXY_AUTH_ENABLED=True TIMETAGGER_PROXY_AUTH_TRUSTED=127.0.0.1 TIMETAGGER_PROXY_AUTH_HEADER=X-Remote-User
python -m timetagger

If you're self-hosting TimeTagger and want to support the project, you can:

• Write something about TimeTagger in a blog post or social media (and link to https://timetagger.app). This helps search engines find it better.
• Contribute improvements via Github.
• For financial support you can take a subscription or donate (see the donation links on the side).

You can also make use of https://timetagger.app so you don't have to worry about maintaining a server, backups, and all that. An account is just €3 per month. With that you'd also sponsor this project and open source in general.

As usual, copyright applies to whomever made a particular contribution in this repository, which can be inspected via e.g. git blame. The owner of the copyright (i.e. the author) is free to use their code in any way.

This code is also subject to the GPL-3.0 License, to protect it from being used commercially by other parties.

Contributors must agree to the Contributor License Agreement to grant me (Almar) the right to use their contributions at e.g. the TimeTagger.app service. By making a contribution to this project, you agree to this CLA.

Clone the repo and install in development mode:

git clone https://github.com/almarklein/timetagger.git
cd timetagger
pip install -e .

Install additional developer dependencies:

pip install invoke black flake8 pytest pytest-cov requests

Then these commands can be used during development:

• invoke -l to see available invoke tasks
• invoke clean to remove temporary files
• invoke format to autoformat the code (using black)
• invoke lint to detect linting errors (using flake8)
• invoke tests to run tests (using pytest)

We welcome contributions to TimeTagger! If you're interested in helping improve the project, please check out our contribution guidelines for information on code style, linting requirements, and the pull request process.

TimeTagger includes tools to help maintain code quality:

• Run python scripts/lint_code.py to check for common issues
• Run python scripts/lint_code.py --fix to automatically fix some problems
• Use python -m invoke format to format code with Black
• Use python -m invoke lint to check code style with flake8
• Use python -m invoke tests to run the test suite

TimeTagger supports two database options:

For single-user instances or smaller deployments, SQLite provides a simple, file-based database solution. This is the default configuration and requires minimal setup.

For multi-user environments or larger deployments, PostgreSQL offers better performance, concurrency, and reliability. To use PostgreSQL:

1. Configure your database connection in your .env file:

POSTGRES_USER=timetagger
POSTGRES_PASSWORD=your_secure_password
POSTGRES_DB=timetagger
POSTGRES_HOST=localhost
POSTGRES_PORT=5432
TIMETAGGER_DB_URL=postgresql://timetagger:your_secure_password@localhost:5432/timetagger

2. Run the migration script if you're transitioning from SQLite:

python scripts/migrate_to_postgres.py --all --login-db --validate

See the documentation for more details on database configuration options.