stempeluhr 1.6.0__tar.gz

stempeluhr-1.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Andre Wohnsland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

stempeluhr-1.6.0/PKG-INFO

@@ -0,0 +1,158 @@
+Metadata-Version: 2.4
+Name: stempeluhr
+Version: 1.6.0
+Summary: Stempeluhr: track your working time with a Qt tray app
+Keywords: time-tracking,work-hours,overtime,qt,tray,stempeluhr
+Author: Andre Wohnsland
+Author-email: Andre Wohnsland <50302161+AndreWohnsland@users.noreply.github.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: alembic>=1.19.1
+Requires-Dist: gitpython>=3.1.59
+Requires-Dist: matplotlib>=3.11.1
+Requires-Dist: pandas>=3.0.5
+Requires-Dist: xlsxwriter>=3.2.9
+Requires-Dist: qtawesome>=1.4.2
+Requires-Dist: holidays>=0.103
+Requires-Dist: pyqt6>=6.11.0
+Requires-Dist: numpy>=2.5.2
+Requires-Dist: seaborn>=0.13.2
+Requires-Dist: sqlalchemy>=2.0.52
+Requires-Dist: pyqtdarktheme-fork>=2.3.6
+Requires-Dist: typer>=0.27.1
+Requires-Python: >=3.13
+Project-URL: Repository, https://github.com/AndreWohnsland/TimeTracker
+Description-Content-Type: text/markdown
+
+# Stempeluhr
+
+> *Stempeluhr* (pronounced SHTEM-pel-oor, [ˈʃtɛmpl̩ˌʔuːɐ̯]) is German for *punch clock* — the clock at the factory gate that workers used to stamp their arrival and leaving times onto a time card. This app is that clock, minus the cardboard.
+
+A Qt-Application to start and stop time tracking, enter additional breaks, view your daily and monthly data, and generate a report out of it.
+
+![mainwindow](./doc/mainwindow.PNG 'mainwindow')
+![report](./doc/report.PNG 'report')
+
+## Installation
+
+The easiest way is installing from PyPI, otherwise you can use the standalone version.
+
+### A: Install from PyPI (recommended)
+
+The app is published on PyPI as [`stempeluhr`](https://pypi.org/project/stempeluhr/).
+Install it as a tool with [uv](https://docs.astral.sh/uv/getting-started/installation/) (or use `pipx` if you prefer):
+
+```bash
+uv tool install stempeluhr
+stempeluhr
+```
+
+This is especially recommended on macOS, where the standalone binary is not signed and gets blocked by Gatekeeper.
+Update any time with:
+
+```bash
+uv tool upgrade stempeluhr
+```
+
+### B: Standalone Installation
+
+With a new release, there is also a standalone version available.
+You can download the latest release from the [release page](https://github.com/AndreWohnsland/TimeTracker/releases).
+Choose the right version for your operating system and download the file.
+Execute the file according to your usual system start option.
+The application will start and you can use it as described below.
+
+#### Windows
+
+Just use the installer, put it on the desktop, and start the application via the icon.
+
+#### Linux
+
+You probably know your ways how to get started with the binary file.
+But if you are lazy like me, you can install the application with the [following script](https://github.com/AndreWohnsland/TimeTracker/blob/master/scripts/installer.sh):
+
+```bash
+curl -s https://raw.githubusercontent.com/AndreWohnsland/TimeTracker/master/scripts/installer.sh | bash
+```
+
+This will download the latest release, put it into your binary folder, and create an application entry.
+
+#### macOS
+
+This is currently still experimental, but you can try either the manual installation or the standalone version.
+
+### B: Manual Installation
+
+We use [uv](https://docs.astral.sh/uv/getting-started/installation/) for managing Python versions and packages.
+First clone the repository and cd into it.
+To start the app, you run the `runme.py` file, you can create a shortcut on your desktop:
+
+```bash
+git clone https://github.com/AndreWohnsland/TimeTracker.git
+cd TimeTracker
+uv sync
+uv run runme.py
+```
+
+If you want to contribute, also install the [pre-commit](https://pre-commit.com/) hooks, they run linting and formatting before each commit:
+
+```bash
+uv run pre-commit install
+```
+
+### Manual build of the standalone version
+
+If you want to build the standalone version by yourself, you can also do it with [uv](https://docs.astral.sh/uv/getting-started/installation/).
+Especially on windows and macOS, because on these systems, they will probably complain that the downloaded binary is not trusted.
+First, make sure you have uv installed and clone the repository.
+Then run the following commands to create the standalone version:
+
+```bash
+uv run pyinstaller installer.spec
+```
+
+The created binary will be in the `dist` folder.
+
+## Options
+
+On first startup, the application will create the needed configuration and the database.
+You can adjust your settings via `Options > Configure Settings` and the folder to save the reports to with `Options > Set Save folder`.
+With `Start` the tracking is started and with `Stop` the tracking is stopped.
+You can repeat this start-stop procedure any time you want.
+Over the spin box you can select the pause time and submit them with the `Pause` button.
+It is also possible to enter negative Pause to correct previous mistakes.
+You can also start and stop over the tray icon in the taskbar.
+
+![settings](./doc/options.PNG 'settings')
+
+## Reports
+
+An overview can be seen when clicking `Options > Summary`.
+With a datepicker, a day can be chosen to display a summary of the data in either the according month or all events of this day.
+The day / month view can be changed over the view toggle button.
+To generate the report of your overtime or work time, click the `Export` button.
+By default settings, the report will be saved into the reports folder of this application.
+As soon as the save folder was changed over the option setting, the app will use this location instead.
+The default work time for overtime is eight hours, time worked less than eight will displayed as zero overtime.
+The overtime/work time is rounded to the closest quarter hour.
+Breaks are already subtracted in the calculation, adherence to the regular break times is not observed.
+
+## Adjust Past Values
+
+To enter values you have missed, you can switch to past entry mode.
+This can be done over the `Options > Switch to Past Entry` setting.
+A date and time can be selected with the according action to insert past values.
+To go back to the default option, click the shown back button.
+
+## Updating to latest Version
+
+Just download the latest executable from the [release page](https://github.com/AndreWohnsland/TimeTracker/releases).
+If you have installed the application manually, you can update it with git:
+
+```bash
+git pull
+uv sync
+```

stempeluhr-1.6.0/README.md

@@ -0,0 +1,129 @@
+# Stempeluhr
+
+> *Stempeluhr* (pronounced SHTEM-pel-oor, [ˈʃtɛmpl̩ˌʔuːɐ̯]) is German for *punch clock* — the clock at the factory gate that workers used to stamp their arrival and leaving times onto a time card. This app is that clock, minus the cardboard.
+
+A Qt-Application to start and stop time tracking, enter additional breaks, view your daily and monthly data, and generate a report out of it.
+
+![mainwindow](./doc/mainwindow.PNG 'mainwindow')
+![report](./doc/report.PNG 'report')
+
+## Installation
+
+The easiest way is installing from PyPI, otherwise you can use the standalone version.
+
+### A: Install from PyPI (recommended)
+
+The app is published on PyPI as [`stempeluhr`](https://pypi.org/project/stempeluhr/).
+Install it as a tool with [uv](https://docs.astral.sh/uv/getting-started/installation/) (or use `pipx` if you prefer):
+
+```bash
+uv tool install stempeluhr
+stempeluhr
+```
+
+This is especially recommended on macOS, where the standalone binary is not signed and gets blocked by Gatekeeper.
+Update any time with:
+
+```bash
+uv tool upgrade stempeluhr
+```
+
+### B: Standalone Installation
+
+With a new release, there is also a standalone version available.
+You can download the latest release from the [release page](https://github.com/AndreWohnsland/TimeTracker/releases).
+Choose the right version for your operating system and download the file.
+Execute the file according to your usual system start option.
+The application will start and you can use it as described below.
+
+#### Windows
+
+Just use the installer, put it on the desktop, and start the application via the icon.
+
+#### Linux
+
+You probably know your ways how to get started with the binary file.
+But if you are lazy like me, you can install the application with the [following script](https://github.com/AndreWohnsland/TimeTracker/blob/master/scripts/installer.sh):
+
+```bash
+curl -s https://raw.githubusercontent.com/AndreWohnsland/TimeTracker/master/scripts/installer.sh | bash
+```
+
+This will download the latest release, put it into your binary folder, and create an application entry.
+
+#### macOS
+
+This is currently still experimental, but you can try either the manual installation or the standalone version.
+
+### B: Manual Installation
+
+We use [uv](https://docs.astral.sh/uv/getting-started/installation/) for managing Python versions and packages.
+First clone the repository and cd into it.
+To start the app, you run the `runme.py` file, you can create a shortcut on your desktop:
+
+```bash
+git clone https://github.com/AndreWohnsland/TimeTracker.git
+cd TimeTracker
+uv sync
+uv run runme.py
+```
+
+If you want to contribute, also install the [pre-commit](https://pre-commit.com/) hooks, they run linting and formatting before each commit:
+
+```bash
+uv run pre-commit install
+```
+
+### Manual build of the standalone version
+
+If you want to build the standalone version by yourself, you can also do it with [uv](https://docs.astral.sh/uv/getting-started/installation/).
+Especially on windows and macOS, because on these systems, they will probably complain that the downloaded binary is not trusted.
+First, make sure you have uv installed and clone the repository.
+Then run the following commands to create the standalone version:
+
+```bash
+uv run pyinstaller installer.spec
+```
+
+The created binary will be in the `dist` folder.
+
+## Options
+
+On first startup, the application will create the needed configuration and the database.
+You can adjust your settings via `Options > Configure Settings` and the folder to save the reports to with `Options > Set Save folder`.
+With `Start` the tracking is started and with `Stop` the tracking is stopped.
+You can repeat this start-stop procedure any time you want.
+Over the spin box you can select the pause time and submit them with the `Pause` button.
+It is also possible to enter negative Pause to correct previous mistakes.
+You can also start and stop over the tray icon in the taskbar.
+
+![settings](./doc/options.PNG 'settings')
+
+## Reports
+
+An overview can be seen when clicking `Options > Summary`.
+With a datepicker, a day can be chosen to display a summary of the data in either the according month or all events of this day.
+The day / month view can be changed over the view toggle button.
+To generate the report of your overtime or work time, click the `Export` button.
+By default settings, the report will be saved into the reports folder of this application.
+As soon as the save folder was changed over the option setting, the app will use this location instead.
+The default work time for overtime is eight hours, time worked less than eight will displayed as zero overtime.
+The overtime/work time is rounded to the closest quarter hour.
+Breaks are already subtracted in the calculation, adherence to the regular break times is not observed.
+
+## Adjust Past Values
+
+To enter values you have missed, you can switch to past entry mode.
+This can be done over the `Options > Switch to Past Entry` setting.
+A date and time can be selected with the according action to insert past values.
+To go back to the default option, click the shown back button.
+
+## Updating to latest Version
+
+Just download the latest executable from the [release page](https://github.com/AndreWohnsland/TimeTracker/releases).
+If you have installed the application manually, you can update it with git:
+
+```bash
+git pull
+uv sync
+```

stempeluhr-1.6.0/pyproject.toml

@@ -0,0 +1,121 @@
+[project]
+name = "stempeluhr"
+version = "1.6.0"
+description = "Stempeluhr: track your working time with a Qt tray app"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.13"
+keywords = [
+    "time-tracking",
+    "work-hours",
+    "overtime",
+    "qt",
+    "tray",
+    "stempeluhr",
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "alembic>=1.19.1",
+    "gitpython>=3.1.59",
+    "matplotlib>=3.11.1",
+    "pandas>=3.0.5",
+    "xlsxwriter>=3.2.9",
+    "qtawesome>=1.4.2",
+    "holidays>=0.103",
+    "pyqt6>=6.11.0",
+    "numpy>=2.5.2",
+    "seaborn>=0.13.2",
+    "sqlalchemy>=2.0.52",
+    "pyqtdarktheme-fork>=2.3.6",
+    "typer>=0.27.1",
+]
+
+[[project.authors]]
+name = "Andre Wohnsland"
+email = "50302161+AndreWohnsland@users.noreply.github.com"
+
+[project.urls]
+Repository = "https://github.com/AndreWohnsland/TimeTracker"
+
+[project.scripts]
+stempeluhr = "stempeluhr.main:app"
+
+[build-system]
+requires = ["uv_build>=0.9.5,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["stempeluhr"]
+module-root = ""
+
+[tool.ty.src]
+exclude = ["stempeluhr/ui"]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 120
+exclude = [
+    "stempeluhr/ui",
+    "*.ipynb",
+]
+
+[tool.ruff.lint]
+extend-safe-fixes = [
+    "UP",
+    "D107",
+    "D205",
+    "W291",
+]
+select = [
+    "A",
+    "ANN",
+    "C",
+    "C4",
+    "D",
+    "E",
+    "F",
+    "I",
+    "ICN001",
+    "PIE",
+    "PL",
+    "PTH",
+    "PYI",
+    "Q",
+    "R",
+    "RET",
+    "RUF",
+    "SIM",
+    "UP",
+    "W",
+]
+ignore = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+    "D105",
+    "D203",
+    "D213",
+    "ANN401",
+]
+
+[tool.ruff.lint.per-file-ignores]
+"stempeluhr/main.py" = ["PLC0415"]
+"tests/*" = ["PLR2004"]
+
+[dependency-groups]
+dev = [
+    "pyinstaller>=6.22.2",
+    "jupyterlab>=4.6.3",
+    "ty==0.0.73",
+    "ruff>=0.16.4",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "pre-commit>=4.6.2",
+]

stempeluhr-1.6.0/pyproject.toml.orig

@@ -0,0 +1,109 @@
+[project]
+name = "stempeluhr"
+version = "1.6.0"
+description = "Stempeluhr: track your working time with a Qt tray app"
+authors = [{ name = "Andre Wohnsland", email = "50302161+AndreWohnsland@users.noreply.github.com" }]
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.13"
+keywords = ["time-tracking", "work-hours", "overtime", "qt", "tray", "stempeluhr"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+
+dependencies = [
+    "alembic>=1.19.1",
+    "gitpython>=3.1.59",
+    "matplotlib>=3.11.1",
+    "pandas>=3.0.5",
+    "xlsxwriter>=3.2.9",
+    "qtawesome>=1.4.2",
+    "holidays>=0.103",
+    "pyqt6>=6.11.0",
+    "numpy>=2.5.2",
+    "seaborn>=0.13.2",
+    "sqlalchemy>=2.0.52",
+    "pyqtdarktheme-fork>=2.3.6",
+    "typer>=0.27.1",
+]
+
+[project.urls]
+Repository = "https://github.com/AndreWohnsland/TimeTracker"
+
+[project.scripts]
+stempeluhr = "stempeluhr.main:app"
+
+[build-system]
+requires = ["uv_build>=0.9.5,<0.13.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = ["stempeluhr"]
+module-root = ""
+
+[dependency-groups]
+dev = [
+    "pyinstaller>=6.22.2",
+    "jupyterlab>=4.6.3",
+    "ty==0.0.73",
+    "ruff>=0.16.4",
+    "pytest>=9.1.1",
+    "pytest-cov>=7.1.0",
+    "pre-commit>=4.6.2",
+]
+
+[tool.ty.src]
+# stempeluhr/ui/ holds pyuic6-generated code, same exclusion as ruff
+exclude = ["stempeluhr/ui"]
+
+[tool.ruff]
+target-version = "py313"
+line-length = 120
+# stempeluhr/ui/ holds pyuic6-generated code
+exclude = ["stempeluhr/ui", "*.ipynb"]
+
+[tool.ruff.lint]
+extend-safe-fixes = [
+  "UP", # pyupgrade
+  "D107", # Missing docstring in __init__
+  "D205", # 1 blank line required between summary line and description
+  "W291", # Trailing whitespace
+]
+# main.py imports lazily: data prep must run before the GUI modules' import-time singletons
+per-file-ignores = { "stempeluhr/main.py" = ["PLC0415"], "tests/*" = ["PLR2004"] }
+select = [
+  "A", # flake8-builtins
+  "ANN", # Type annotations
+  "C", # Convention
+  "C4", # flake-comprehensions
+  "D", # pydocstyle 
+  "E", # pycodestyle
+  "F", # Pyflakes
+  "I", # isort
+  "ICN001", # {name} should be imported as {asname},
+  "PIE", # flake8-pie
+  "PL", # pylint
+  "PTH", # flake8-use-pathlib
+  "PYI", # flake8-pyi
+  "Q", # flake8-quotes
+  "R", # Refactor
+  "RET", # flake8-return
+  "RUF", # Ruff
+  "SIM", # flake8-simplify
+  "UP", # pyupgrade
+  "W", # Pylint (Warning)
+]
+ignore = [
+  "D100", # Missing docstring in public module
+  "D101", # Missing docstring in public class
+  "D102", # Missing docstring in public method
+  "D103",  # Missing docstring in public function
+  "D104", # Missing docstring in public package
+  "D105", # Missing docstring in magic method
+  "D203", # 1 blank line required before class docstring
+  "D213", # Multi-line docstring summary should start at the second line
+  "ANN401", # Dynamically typed expressions (typing.Any) are disallowed
+]

stempeluhr-1.6.0/stempeluhr/__init__.py

@@ -0,0 +1 @@
+__version__ = "1.5.1"

stempeluhr-1.6.0/stempeluhr/config_handler.py

@@ -0,0 +1,95 @@
+import datetime
+import json
+from dataclasses import asdict, dataclass
+from inspect import signature
+from typing import Any, Literal
+
+import holidays
+
+from stempeluhr.filepath import CONFIG_PATH
+
+# Fill data currently not in the config file,
+# need at least all that config has
+NEEDED_DATA = {
+    "name": "",
+    "project_names": ["Default"],
+    "save_path": "",
+    "country": "US",
+    "subdiv": None,
+}
+CONFIG_NAMES = Literal[
+    "name",
+    "project_names",
+    "save_path",
+    "country",
+    "subdiv",
+]
+
+
+@dataclass
+class Config:
+    name: str
+    project_names: list[str]
+    save_path: str
+    country: str
+    subdiv: str | None
+
+    @classmethod
+    def from_kwargs(cls, **kwargs: Any) -> "Config":
+        cls_fields = set(signature(cls).parameters)
+
+        class_args, other_args = {}, {}
+        for name, val in kwargs.items():
+            if name in cls_fields:
+                class_args[name] = val
+                continue
+            other_args[name] = val
+
+        c = cls(**class_args)
+        for new_name, new_val in other_args.items():
+            setattr(c, new_name, new_val)
+        return c
+
+    def __getitem__(self, item: CONFIG_NAMES) -> Any:
+        return getattr(self, item)
+
+    def get_holidays(self, year: int) -> list[datetime.date]:
+        available_holidays = holidays.country_holidays(self.country, subdiv=self.subdiv or None, years=year)
+        return list(available_holidays.keys())
+
+
+class ConfigHandler:
+    def __init__(self) -> None:
+        """Class for managing configuration file and settings ."""
+        self.config = self._get_config()
+
+    def _get_config(self) -> Config:
+        config_file = self.read_config_file()
+        return Config.from_kwargs(**config_file)
+
+    def read_config_file(self) -> dict:
+        if not CONFIG_PATH.exists():
+            return NEEDED_DATA
+        with CONFIG_PATH.open(encoding="utf-8") as f:
+            config = json.load(f)
+        for d in NEEDED_DATA.items():
+            if d[0] not in config:
+                config[d[0]] = d[1]
+        return config
+
+    def write_config_file(self) -> None:
+        with CONFIG_PATH.open("w", encoding="utf-8") as write_file:
+            json.dump(asdict(self.config), write_file)
+
+    def set_config_value(self, key: CONFIG_NAMES, value: Any, write: bool = True) -> None:
+        setattr(self.config, key, value)
+        if not write:
+            return
+        self.write_config_file()
+
+    def config_hash(self) -> int:
+        """Get a hash of the current config."""
+        return hash(json.dumps(asdict(self.config)))
+
+
+CONFIG_HANDLER = ConfigHandler()