d8s-timer 0.5.0__tar.gz → 0.6.0__tar.gz

{d8s_timer-0.5.0 → d8s_timer-0.6.0}/.coveragerc

@@ -1,5 +1,4 @@
 [run]
 omit =
     tests/*
-    setup.py
     conftest.py

d8s_timer-0.6.0/.github/dependabot.yml

@@ -0,0 +1,8 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: "deps"

d8s_timer-0.5.0/.github/workflows/pytest.yml → d8s_timer-0.6.0/.github/workflows/ci.yml

@@ -9,48 +9,64 @@ on:
   pull_request:
     branches: [ main ]
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  build_multi_os:
+  build_smoke:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python 3.14
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.14'
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+    - name: Build package
+      run: uv build
 
+  build_multi_os:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [macos-latest, windows-latest, ubuntu-latest]
-        python-version: [3.9]
+        python-version: ['3.14']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt
-        python -m pip install -r requirements_dev.txt
+      run: uv sync --locked --group dev
     - name: Run pytest
       run: |
-        pytest
-        codecov
+        uv run pytest
+        uv run codecov
 
   build_multi_py_versions:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest]
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
     - name: Install dependencies
-      run: |
-        python -m pip install -r requirements.txt
-        python -m pip install -r requirements_dev.txt
+      run: uv sync --locked --group dev
     - name: Run pytest
       run: |
-        pytest
-        codecov
+        uv run pytest
+        uv run codecov

d8s_timer-0.6.0/.github/workflows/dependabot-auto-merge.yml

@@ -0,0 +1,67 @@
+name: Dependabot auto-merge
+
+on:
+  pull_request_target:
+  schedule:
+    - cron: "11 11 * * *"
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  label:
+    if: github.event_name == 'pull_request_target' && github.actor == 'dependabot[bot]'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch Dependabot metadata
+        id: meta
+        uses: dependabot/fetch-metadata@v2
+
+      - name: Ensure labels exist
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh label create auto-merge-candidate --color ededed --description "Dependabot dev-dep PR eligible for auto-merge after soak" --force --repo "$GITHUB_REPOSITORY"
+          gh label create needs-manual-merge --color d93f0b --description "Dependabot PR not eligible for auto-merge; needs manual review" --force --repo "$GITHUB_REPOSITORY"
+
+      - name: Label auto-merge candidates
+        if: steps.meta.outputs.dependency-type == 'direct:development' && (steps.meta.outputs.update-type == 'version-update:semver-patch' || steps.meta.outputs.update-type == 'version-update:semver-minor')
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+        run: gh pr edit "$PR_URL" --add-label auto-merge-candidate
+
+      - name: Label PRs needing manual review
+        if: ${{ !(steps.meta.outputs.dependency-type == 'direct:development' && (steps.meta.outputs.update-type == 'version-update:semver-patch' || steps.meta.outputs.update-type == 'version-update:semver-minor')) }}
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PR_URL: ${{ github.event.pull_request.html_url }}
+        run: gh pr edit "$PR_URL" --add-label needs-manual-merge
+
+  soak-and-merge:
+    if: github.event_name == 'schedule' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    env:
+      SOAK_DAYS: 3
+    steps:
+      - name: Enable auto-merge on soaked PRs
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          cutoff=$(date -u -d "${SOAK_DAYS} days ago" +%Y-%m-%dT%H:%M:%SZ)
+          gh pr list \
+            --repo "$GITHUB_REPOSITORY" \
+            --author "app/dependabot" \
+            --label auto-merge-candidate \
+            --state open \
+            --json number,createdAt,autoMergeRequest \
+            --jq ".[] | select(.createdAt < \"$cutoff\") | .number" \
+          | while read -r pr; do
+              auto=$(gh pr view "$pr" --repo "$GITHUB_REPOSITORY" --json autoMergeRequest --jq .autoMergeRequest)
+              if [ "$auto" = "null" ] || [ -z "$auto" ]; then
+                echo "Enabling auto-merge on PR #$pr"
+                gh pr merge "$pr" --auto --squash --repo "$GITHUB_REPOSITORY" || echo "Failed to enable auto-merge on PR #$pr"
+              fi
+            done

d8s_timer-0.6.0/.github/workflows/lint.yml

@@ -0,0 +1,32 @@
+# This workflow will install Python dependencies and lint the code with ruff and mypy
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: Lint
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.14'
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+    - name: Install dependencies
+      run: uv sync --locked --group dev
+    - name: Lint
+      env:
+        CONTEXT: ci
+      run: ./docker/lint.sh

d8s_timer-0.6.0/.github/workflows/release-please.yml

@@ -0,0 +1,51 @@
+# Conventional-commit release automation.
+# On every push to main, release-please maintains a release PR (CHANGELOG +
+# version bump in pyproject.toml + d8s_lists/__init__.py). Merging that PR
+# tags vX.Y.Z and creates the GitHub Release; this same run then builds and
+# publishes to PyPI via OIDC.
+#
+# Publish is folded into THIS workflow on purpose: a tag pushed by
+# release-please uses GITHUB_TOKEN, which does NOT trigger a separate
+# tag-triggered workflow. Gating on release_created keeps OIDC (no PAT/secrets).
+
+name: release-please
+
+on:
+  push:
+    branches:
+      - main
+
+permissions:
+  contents: write        # create release PR, tag, and GitHub Release
+  pull-requests: write   # open/update the release PR
+
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    outputs:
+      release_created: ${{ steps.release.outputs.release_created }}
+      tag_name: ${{ steps.release.outputs.tag_name }}
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release
+        with:
+          config-file: release-please-config.json
+          manifest-file: .release-please-manifest.json
+
+  publish:
+    needs: release-please
+    if: needs.release-please.outputs.release_created == 'true'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write    # required for OIDC trusted publishing
+      contents: read
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.release-please.outputs.tag_name }}
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+      - name: Build
+        run: uv build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

d8s_timer-0.6.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.6.0"
+}

d8s_timer-0.6.0/AGENTS.md

@@ -0,0 +1,38 @@
+# AGENTS.md
+
+## Commit messages: use Conventional Commits
+
+Releases are automated by [release-please](https://github.com/googleapis/release-please).
+It reads commit messages to bump the version, write `CHANGELOG.md`, tag, and publish to
+PyPI. **Non-conventional commits are silently ignored** — no version bump, absent from the
+changelog.
+
+Format: `type: description` (optionally `type(scope): description`).
+
+Common types and their effect on the release:
+
+| Type | Effect | Changelog section |
+|------|--------|-------------------|
+| `feat:` | minor bump (0.8.0 → 0.9.0) | Features |
+| `fix:` | patch bump (0.8.0 → 0.8.1) | Bug Fixes |
+| `perf:` | patch bump | Performance Improvements |
+| `deps:` | no bump (rides next release) | Dependencies |
+| `docs:` `refactor:` `test:` `chore:` `ci:` `build:` `style:` | no bump | hidden |
+
+Breaking change: append `!` (`feat!: ...`) or add a `BREAKING CHANGE:` footer → major bump.
+
+Examples:
+
+```
+feat: add iterable_chunk
+fix: cycle() returns empty when length is 0
+feat!: rename list_flatten to iterable_flatten
+```
+
+Prefer squash-merging PRs so the PR title becomes the single conventional commit.
+
+## Releasing
+
+Don't bump versions, edit `CHANGELOG.md`, or create tags by hand — release-please owns all
+three. To cut a release, merge the open `chore: release X.Y.Z` PR; that tags the version,
+creates the GitHub Release, and publishes to PyPI via OIDC.

d8s_timer-0.6.0/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## [0.6.0](https://github.com/democritus-project/d8s-timer/compare/v0.5.0...v0.6.0) (2026-07-01)
+
+
+### Features
+
+* modernize tooling and release automation ([6020b86](https://github.com/democritus-project/d8s-timer/commit/6020b860d7e64a169542727a9eb4bd30ea4056bd))

d8s_timer-0.6.0/CLAUDE.md

@@ -0,0 +1 @@
+Read AGENTS.md in the repository root and follow it.

d8s_timer-0.6.0/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.4
+Name: d8s_timer
+Version: 0.6.0
+Summary: Democritus functions for working with timers.
+Project-URL: Source, https://github.com/democritus-project/d8s-timer
+Project-URL: Issues, https://github.com/democritus-project/d8s-timer/issues
+Author: Floyd Hightower
+License: GNU Lesser General Public License v3
+License-File: COPYING
+License-File: COPYING.LESSER
+Keywords: clock,democritus,python,time,timers,timers-utility,utility
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: d8s-dates<1.0,>=0.7.0
+Requires-Dist: d8s-uuids<1.0,>=0.6.0
+Description-Content-Type: text/markdown
+
+# Democritus Timer
+
+[![PyPI](https://img.shields.io/pypi/v/d8s-timer.svg)](https://pypi.python.org/pypi/d8s-timer)
+[![CI](https://github.com/democritus-project/d8s-timer/workflows/CI/badge.svg)](https://github.com/democritus-project/d8s-timer/actions)
+[![Lint](https://github.com/democritus-project/d8s-timer/workflows/Lint/badge.svg)](https://github.com/democritus-project/d8s-timer/actions)
+[![codecov](https://codecov.io/gh/democritus-project/d8s-timer/branch/main/graph/badge.svg?token=V0WOIXRGMM)](https://codecov.io/gh/democritus-project/d8s-timer)
+[![The Democritus Project uses semver version 2.0.0](https://img.shields.io/badge/-semver%20v2.0.0-22bfda)](https://semver.org/spec/v2.0.0.html)
+[![The Democritus Project uses ruff to format and lint code](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://choosealicense.com/licenses/lgpl-3.0/)
+
+Democritus functions<sup>[1]</sup> for working with timers.
+
+[1] Democritus functions are <i>simple, effective, modular, well-tested, and well-documented</i> Python functions.
+
+We use `d8s` (pronounced "dee-eights") as an abbreviation for `democritus` (you can read more about this [here](https://github.com/democritus-project/roadmap#what-is-d8s)).
+
+## Installation
+
+```
+pip install d8s-timer
+```
+
+## Usage
+
+You import the library like:
+
+```python
+from d8s_timer import *
+```
+
+Once imported, you can use any of the functions listed below.
+
+## Functions
+
+  - ```python
+    def timer_start(name: str = None) -> str:
+        """Start a timer with the given name. Timers can be stopped with the `timer_stop` function."""
+    ```
+  - ```python
+    def timer_get_time(name: str) -> float:
+        """Get the current time for the timer with the given name."""
+    ```
+  - ```python
+    def timer_stop(name: str) -> float:
+        """Stop a timer (you can start a timer with the `timer_start` function)."""
+    ```
+  - ```python
+    def time_it(func):
+        """Return the time it takes func to execute."""
+    ```
+
+## Development
+
+👋 &nbsp;If you want to get involved in this project, we have some short, helpful guides below:
+
+- [contribute to this project 🥇][contributing]
+- [test it 🧪][local-dev]
+- [lint it 🧹][local-dev]
+- [explore it 🔭][local-dev]
+
+If you have any questions or there is anything we did not cover, please raise an issue and we'll be happy to help.
+
+## Credits
+
+This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and Floyd Hightower's [Python project template](https://github.com/fhightower-templates/python-project-template).
+
+[contributing]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#contributing-a-pr-
+[local-dev]: https://github.com/democritus-project/.github/blob/main/CONTRIBUTING.md#local-development-

{d8s_timer-0.5.0 → d8s_timer-0.6.0}/README.md

@@ -5,7 +5,7 @@
 [![Lint](https://github.com/democritus-project/d8s-timer/workflows/Lint/badge.svg)](https://github.com/democritus-project/d8s-timer/actions)
 [![codecov](https://codecov.io/gh/democritus-project/d8s-timer/branch/main/graph/badge.svg?token=V0WOIXRGMM)](https://codecov.io/gh/democritus-project/d8s-timer)
 [![The Democritus Project uses semver version 2.0.0](https://img.shields.io/badge/-semver%20v2.0.0-22bfda)](https://semver.org/spec/v2.0.0.html)
-[![The Democritus Project uses black to format code](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![The Democritus Project uses ruff to format and lint code](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![License: LGPL v3](https://img.shields.io/badge/License-LGPL%20v3-blue.svg)](https://choosealicense.com/licenses/lgpl-3.0/)
 
 Democritus functions<sup>[1]</sup> for working with timers.

d8s_timer-0.6.0/d8s_timer/__init__.py

@@ -0,0 +1,5 @@
+from .timer import *
+
+__version__ = "0.6.0"
+__author__ = """Floyd Hightower"""
+__email__ = "floyd.hightower27@gmail.com"

{d8s_timer-0.5.0 → d8s_timer-0.6.0}/d8s_timer/timer.py

@@ -1,4 +1,5 @@
 import functools
+from typing import Optional
 
 from d8s_dates import time_now
 from d8s_uuids import uuid4
@@ -26,7 +27,7 @@ class Timer:
 _timer_object = Timer()
 
 
-def timer_start(name: str = None) -> str:
+def timer_start(name: Optional[str] = None) -> str:
     """Start a timer with the given name. Timers can be stopped with the `timer_stop` function."""
     # if there is no name given, use a generic name
     if name is None:
@@ -54,7 +55,7 @@ def _get_time_difference(timer_time: int) -> float:
 def timer_get_time(name: str) -> float:
     """Get the current time for the timer with the given name."""
     if not _timer_object.has_timer(name, print_errors=True):
-        message = f'There is no timer with the name {name}'
+        message = f"There is no timer with the name {name}"
         raise ValueError(message)
 
     time_difference = _get_time_difference(_timer_object.timers[name])
@@ -64,7 +65,7 @@ def timer_get_time(name: str) -> float:
 def timer_stop(name: str) -> float:
     """Stop a timer (you can start a timer with the `timer_start` function)."""
     if not _timer_object.has_timer(name, print_errors=True):
-        message = f'There is no timer with the name {name}'
+        message = f"There is no timer with the name {name}"
         raise ValueError(message)
 
     time_difference = _get_time_difference(_timer_object.timers[name])

d8s_timer-0.6.0/docker/lint.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+set -euxo pipefail
+
+echo "Running linters and formatters..."
+
+uv run ruff check --fix d8s_timer/ tests/
+uv run ruff format d8s_timer/ tests/
+
+# if the CONTEXT env var is "ci" (which is set in .github/workflows/lint.yml), validate that none of the files
+# have been changed by the previous lint steps
+if [ "${CONTEXT:-local}" = "ci" ]; then
+    (git status | grep "nothing to commit") || { echo "Lint steps have changed files"; exit 1; };
+fi
+
+uv run mypy d8s_timer/ tests/
+uv run ruff check d8s_timer/ tests/
+
+echo "Done ✨ 🎉 ✨"

d8s_timer-0.6.0/pyproject.toml

@@ -0,0 +1,67 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "d8s_timer"
+version = "0.6.0"
+description = "Democritus functions for working with timers."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "GNU Lesser General Public License v3" }
+authors = [{ name = "Floyd Hightower" }]
+keywords = ["democritus", "utility", "python", "timers", "timers-utility", "time", "clock"]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+    "Natural Language :: English",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "d8s-dates>=0.7.0,<1.0",
+    "d8s-uuids>=0.6.0,<1.0",
+]
+
+[project.urls]
+Source = "https://github.com/democritus-project/d8s-timer"
+Issues = "https://github.com/democritus-project/d8s-timer/issues"
+
+[dependency-groups]
+dev = [
+    "codecov>=2.1.13,<3.0",
+    "d8s-file-system>=0.10.0,<1.0",
+    "d8s-python>=0.9.0,<1.0",
+    "d8s-strings>=0.5.0,<1.0",
+    "ipython>=8.18.0,<10.0",
+    "mypy>=2.0,<3.0",
+    "pytest>=9.0,<10.0",
+    "pytest-cov>=7.0,<8.0",
+    "ruff>=0.15.0,<0.16.0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["d8s_timer"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I"]
+
+[tool.ruff.lint.per-file-ignores]
+"d8s_timer/__init__.py" = ["F401", "F403"]
+"tests/*" = ["E501"]
+
+[tool.mypy]
+ignore_missing_imports = true
+
+[tool.pytest.ini_options]
+addopts = "-v --cov=. --cov-report term-missing --cov-fail-under 90"
+python_files = "tests/test_*.py"

d8s_timer-0.6.0/release-please-config.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "packages": {
+    ".": {
+      "release-type": "python",
+      "package-name": "d8s_timer",
+      "include-component-in-tag": false,
+      "changelog-sections": [
+        { "type": "feat", "section": "Features" },
+        { "type": "fix", "section": "Bug Fixes" },
+        { "type": "perf", "section": "Performance Improvements" },
+        { "type": "deps", "section": "Dependencies" },
+        { "type": "revert", "section": "Reverts" },
+        { "type": "docs", "section": "Documentation", "hidden": true },
+        { "type": "chore", "section": "Miscellaneous", "hidden": true },
+        { "type": "refactor", "section": "Code Refactoring", "hidden": true },
+        { "type": "style", "section": "Styles", "hidden": true },
+        { "type": "test", "section": "Tests", "hidden": true },
+        { "type": "build", "section": "Build System", "hidden": true },
+        { "type": "ci", "section": "Continuous Integration", "hidden": true }
+      ]
+    }
+  }
+}

{d8s_timer-0.5.0 → d8s_timer-0.6.0}/tests/test_timer.py

@@ -6,7 +6,7 @@ from d8s_timer import time_it, timer_get_time, timer_start, timer_stop
 
 
 def test_timer_get_time_1():
-    timer_name = 'foo'
+    timer_name = "foo"
     timer_start(timer_name)
     time.sleep(2)
     current_time = timer_get_time(timer_name)
@@ -16,7 +16,7 @@ def test_timer_get_time_1():
 
 def test_timer_get_time__invalid_name():
     with pytest.raises(ValueError):
-        timer_get_time('foo')
+        timer_get_time("foo")
 
 
 def test_generic_timer_1():
@@ -31,7 +31,7 @@ def test_generic_timer__invalid_name():
     timer_name = timer_start()
 
     with pytest.raises(ValueError):
-        timer_stop('foo')
+        timer_stop("foo")
 
     timer_stop(timer_name)
 
@@ -42,7 +42,7 @@ def test_named_timer_1():
     with pytest.raises(RuntimeError):
         timer_start(timer_name)
 
-    timer_start('bar')
+    timer_start("bar")
 
     time.sleep(2)
 
@@ -51,7 +51,7 @@ def test_named_timer_1():
 
     time.sleep(2)
 
-    bar_elapsed_time = timer_stop('bar')
+    bar_elapsed_time = timer_stop("bar")
     assert 4 < bar_elapsed_time < 5