Metadata-Version: 2.5
Name: stanwell
Version: 0.1.2
Summary: Understand working time and how it is distributed using Toggl time-tracking data.
Author: Jan Buermann
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.12
Requires-Dist: loguru>=0.7.3
Requires-Dist: matplotlib>=3.11.2
Requires-Dist: numpy>=2.5.3
Requires-Dist: pandas>=3.0.6
Requires-Dist: python-dateutil>=2.9.0.post0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: seaborn>=0.13.2
Requires-Dist: streamlit>=1.64.0
Requires-Dist: typer>=0.27.2
Description-Content-Type: text/markdown

[![CI](https://github.com/jbuerman/stanwell/actions/workflows/ci.yml/badge.svg)](https://github.com/jbuerman/stanwell/actions/workflows/ci.yml)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Documentation Status](https://app.readthedocs.org/projects/stanwell/badge/?version=latest)](https://stanwell.readthedocs.io/en/latest/)

# Stanwell

*Have enthusiasm. Work sustainably.*

Stanwell analyses working time recorded in Toggl to help you understand how much you work and how that time
is distributed across projects, activities and working patterns.

**Documentation:** [https://stanwell.readthedocs.io](https://stanwell.readthedocs.io/en/latest/)

## Quick setup

Initialise Stanwell:

```bash
stanwell init
```

Synchronise historical data. Repeat until all missing data has been downloaded:

```bash
stanwell sync-missing
```

Refresh recent entries when needed:

```bash
stanwell refresh-recent
```

Open the interactive dashboard:

```bash
stanwell dashboard
```

## Development

```bash
uv sync --all-groups
```

Format and lint the project:

```bash
uv run make tidy
```

Run the CI checks locally:

```bash
uv run make ci
```

### Documentation

Build the Sphinx documentation:

```bash
uv run make docs
```

Open `docs/_build/html/index.html` to view the generated documentation.

### Integration tests

Create an environment file containing an API token and workspace ID using `.env.integration.example` as a template.

Then run:

```bash
uv run --env-file .env.integration pytest -m integration
```

## Licence

Stanwell is released under the [MIT Licence](LICENSE).
