throttle-controller 0.2.0__tar.gz → 0.3.1__tar.gz

throttle_controller-0.3.1/.github/workflows/gitignore-in.yml

@@ -0,0 +1,16 @@
+name: Update gitignore file
+
+on:
+  schedule:
+    # daily at 00:00
+    - cron: '0 0 * * *'
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-gitignore:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: gitignore-in/gh-action@v0.2.2

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/.github/workflows/happy.yml

@@ -13,6 +13,6 @@ jobs:
     name: happy
     continue-on-error: true
     steps:
-      - uses: kitsuyui/happy-commit@v0.8
+      - uses: kitsuyui/happy-commit@v0.9
         with:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/.github/workflows/pypi-publish.yml

@@ -8,7 +8,7 @@ on:
     types: [prereleased, released]
 
 env:
-  python_version: 3.12
+  python_version: 3.13
 
 jobs:
   deploy:
@@ -18,28 +18,20 @@ jobs:
 
       - name: Set up Python
         id: setup-python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ env.python_version }}
 
-      - name: Set up poetry
-        uses: abatilo/actions-poetry@v2
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
 
-      - name: Cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-build-${{ env.python_version }}-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ env.python_version }}-${{ hashFiles('**/poetry.lock') }}
-            ${{ runner.os }}-build-${{ env.python_version }}-
-            ${{ runner.os }}-
-
-      - run: poetry install
+      - name: Install dependencies
+        run: |
+          uv python pin ${{ env.python_version }}
+          uv sync
 
       - name: Build
-        # I use poetry just as a package manager, so this is not `poetry build`
-        run: poetry run poe build
+        run: uv build
 
       - name: Publish distribution to Test PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/.github/workflows/python-test.yml

@@ -1,14 +1,19 @@
 name: Test
 on:
-  - pull_request
-
+  # pull-request events are not triggered when a PR is merged
+  # push events are not triggered when a PR created from a fork repository
+  # So we need both to run tests on every PR and after merging
+  pull_request:
+  push:
+    branches:
+      - main
 jobs:
   test:
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout
@@ -16,32 +21,24 @@ jobs:
 
       - name: Set up Python
         id: setup-python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "${{ matrix.python }}"
 
-      - name: Set up poetry
-        uses: abatilo/actions-poetry@v2
-
-      - name: Cache
-        uses: actions/cache@v3
-        with:
-          path: ~/.cache/pypoetry/virtualenvs
-          key: ${{ runner.os }}-build-${{ matrix.python }}-${{ hashFiles('**/poetry.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-build-${{ matrix.python }}-${{ hashFiles('**/poetry.lock') }}
-            ${{ runner.os }}-build-${{ matrix.python }}-
-            ${{ runner.os }}-
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v5
 
       - name: Install dependencies
-        run: poetry install
+        run: |
+          uv python pin ${{ matrix.python }}
+          uv sync
 
       - name: Lint
-        run: poetry run poe check
+        run: uv run poe check
 
       - name: Check Python version
         run: |
-          actual_version=$(poetry run python --version)
+          actual_version=$(uv run python --version)
           expected_version="Python ${{ matrix.python }}"
           if [ "$actual_version" == *"$expected_version"* ]; then
             echo "Expected $expected_version, but got $actual_version"
@@ -49,14 +46,14 @@ jobs:
           fi
 
       - name: Test
-        run: poetry run poe test
+        run: uv run poe test
 
       - name: Coverage
-        run: poetry run poe coverage-xml
+        run: uv run poe coverage-xml
 
       - name: Upload coverage report to Codecov
-        if: matrix.python == '3.12'
-        uses: codecov/codecov-action@v3
+        if: matrix.python == '3.13'
+        uses: codecov/codecov-action@v5
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: ./coverage.xml

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/.gitignore

@@ -1,5 +1,11 @@
+# DO NOT EDIT THIS FILE
+# Generated by gitignore.in
+# Edit .gitignore.in instead of this file
+# Run `gitignore.in` to build .gitignore
+# -----------------------------------------------------------------------------
+# gibo dump Linux
 ### Generated by gibo (https://github.com/simonwhitaker/gibo)
-### https://raw.github.com/github/gitignore/e5323759e387ba347a9d50f8b0ddd16502eb71d4/Global/Linux.gitignore
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Linux.gitignore
 
 *~
 
@@ -14,10 +20,10 @@
 
 # .nfs files are created when an open file is removed but is still being accessed
 .nfs*
-
-
+# -----------------------------------------------------------------------------
+# gibo dump Windows
 ### Generated by gibo (https://github.com/simonwhitaker/gibo)
-### https://raw.github.com/github/gitignore/e5323759e387ba347a9d50f8b0ddd16502eb71d4/Global/Windows.gitignore
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/Windows.gitignore
 
 # Windows thumbnail cache files
 Thumbs.db
@@ -43,10 +49,10 @@ $RECYCLE.BIN/
 
 # Windows shortcuts
 *.lnk
-
-
+# -----------------------------------------------------------------------------
+# gibo dump macOS
 ### Generated by gibo (https://github.com/simonwhitaker/gibo)
-### https://raw.github.com/github/gitignore/e5323759e387ba347a9d50f8b0ddd16502eb71d4/Global/macOS.gitignore
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Global/macOS.gitignore
 
 # General
 .DS_Store
@@ -74,10 +80,10 @@ Icon
 Network Trash Folder
 Temporary Items
 .apdisk
-
-
+# -----------------------------------------------------------------------------
+# gibo dump Python
 ### Generated by gibo (https://github.com/simonwhitaker/gibo)
-### https://raw.github.com/github/gitignore/e5323759e387ba347a9d50f8b0ddd16502eb71d4/Python.gitignore
+### https://raw.github.com/github/gitignore/4488915eec0b3a45b5c63ead28f286819c0917de/Python.gitignore
 
 # Byte-compiled / optimized / DLL files
 __pycache__/
@@ -239,6 +245,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-
-
+# -----------------------------------------------------------------------------
 _version.py

throttle_controller-0.3.1/.gitignore.in

@@ -0,0 +1,5 @@
+gibo dump Linux
+gibo dump Windows
+gibo dump macOS
+gibo dump Python
+echo _version.py

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2022 Kitsu Yui
+Copyright 2022-2025 Kitsu Yui
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
 

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/PKG-INFO

@@ -1,28 +1,33 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: throttle-controller
-Version: 0.2.0
+Version: 0.3.1
 Summary: A simple throttling controller
-Home-page: https://github.com/kitsuyui/python-throttle-controller
-Author: Yui Kitsu
-Author-email: kitsuyui+github@kitsuyui.com
-License: BSD-3-Clause
+Author-email: Yui KITSU <kitsuyui+github@kitsuyui.com>
+License: Copyright 2022-2025 Kitsu Yui
+        
+        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/kitsuyui/python-throttle-controller
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 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: Intended Audience :: Developers
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
+Requires-Dist: typing-extensions
 
 # throttle-controller
 

throttle_controller-0.3.1/pyproject.toml

@@ -0,0 +1,67 @@
+[project]
+name = "throttle-controller"
+dynamic = ["version"]
+requires-python = ">=3.9"
+dependencies = ["typing-extensions"]
+description = "A simple throttling controller"
+readme = {file = "README.md", content-type = "text/markdown"}
+license = { file = "LICENSE" }
+authors = [
+    {name = "Yui KITSU", email = "kitsuyui+github@kitsuyui.com"}
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "License :: OSI Approved :: BSD License",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Intended Audience :: Developers",
+]
+
+[project.urls]
+Homepage = "https://github.com/kitsuyui/python-throttle-controller"
+
+[tool.setuptools]
+package-data = { "throttle_controller" = ["py.typed"], "*" = ["README.md, LICENSE"] }
+package-dir = { "throttle_controller" = "throttle_controller" }
+
+[tool.uv]
+dev-dependencies = [
+    "pytest",
+    "pytest-cov",
+    "poethepoet",
+    "setuptools-scm",
+    "ruff",
+    "mypy",
+]
+
+[build-system]
+requires = [
+    "setuptools", "setuptools_scm"
+]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "throttle_controller/_version.py"
+version_scheme = "only-version"
+local_scheme = "no-local-version"
+
+[tool.poe.tasks]
+test = "pytest"
+coverage-xml = "pytest --cov=throttle_controller --doctest-modules --cov-report=xml"
+format = "ruff format throttle_controller"
+check = [
+    { cmd = "ruff check throttle_controller" },
+    { cmd = "mypy throttle_controller tests" },
+]
+build = [
+    { cmd = "python -m build"}
+]
+[tool.mypy]
+strict = true
+ignore_missing_imports = false
+
+[tool.ruff]
+line-length = 79

throttle_controller-0.3.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

throttle_controller-0.3.1/throttle_controller/__init__.py

@@ -0,0 +1,7 @@
+from .protocol import ThrottleController
+from .simple import SimpleThrottleController
+
+# https://packaging-guide.openastronomy.org/en/latest/advanced/versioning.html
+from ._version import __version__
+
+__all__ = ["ThrottleController", "SimpleThrottleController", "__version__"]

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/throttle_controller/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.0'
-__version_tuple__ = version_tuple = (0, 2, 0)
+__version__ = version = '0.3.1'
+__version_tuple__ = version_tuple = (0, 3, 1)

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/throttle_controller/protocol.py

@@ -13,23 +13,19 @@ Key = Hashable
 
 
 class ThrottleController(Protocol):  # pragma: no cover
-    def cooldown_time_for(self, key: Key) -> datetime.timedelta:
-        ...
+    def cooldown_time_for(self, key: Key) -> datetime.timedelta: ...
 
-    def record_use_time(self, key: Key, use_time: datetime.datetime) -> None:
-        ...
+    def record_use_time(
+        self, key: Key, use_time: datetime.datetime
+    ) -> None: ...
 
-    def record_use_time_as_now(self, key: Key) -> None:
-        ...
+    def record_use_time_as_now(self, key: Key) -> None: ...
 
-    def wait_if_needed(self, key: Key) -> None:
-        ...
+    def wait_if_needed(self, key: Key) -> None: ...
 
-    def wait_time_for(self, key: Key) -> datetime.timedelta:
-        ...
+    def wait_time_for(self, key: Key) -> datetime.timedelta: ...
 
-    def next_available_time(self, key: Key) -> datetime.datetime:
-        ...
+    def next_available_time(self, key: Key) -> datetime.datetime: ...
 
     @contextlib.contextmanager
     def use(self, key: Key) -> Generator[None, None, None]:

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/throttle_controller.egg-info/PKG-INFO

@@ -1,28 +1,33 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: throttle-controller
-Version: 0.2.0
+Version: 0.3.1
 Summary: A simple throttling controller
-Home-page: https://github.com/kitsuyui/python-throttle-controller
-Author: Yui Kitsu
-Author-email: kitsuyui+github@kitsuyui.com
-License: BSD-3-Clause
+Author-email: Yui KITSU <kitsuyui+github@kitsuyui.com>
+License: Copyright 2022-2025 Kitsu Yui
+        
+        Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://github.com/kitsuyui/python-throttle-controller
 Classifier: Development Status :: 3 - Alpha
 Classifier: License :: OSI Approved :: BSD License
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 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: Intended Audience :: Developers
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Provides-Extra: dev
-Requires-Dist: pytest; extra == "dev"
-Requires-Dist: black; extra == "dev"
-Requires-Dist: isort; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: mypy; extra == "dev"
+Requires-Dist: typing-extensions
 
 # throttle-controller
 

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/throttle_controller.egg-info/SOURCES.txt

@@ -3,10 +3,10 @@
 .gitignore.in
 LICENSE
 README.md
-poetry.lock
 pyproject.toml
-setup.cfg
+uv.lock
 .github/renovate.json5
+.github/workflows/gitignore-in.yml
 .github/workflows/happy.yml
 .github/workflows/pypi-publish.yml
 .github/workflows/python-test.yml

throttle_controller-0.3.1/throttle_controller.egg-info/requires.txt

@@ -0,0 +1 @@
+typing-extensions

{throttle-controller-0.2.0 → throttle_controller-0.3.1}/throttle_controller.egg-info/top_level.txt

@@ -1,2 +1 @@
-tests
 throttle_controller