renumerate 2.0.0__tar.gz → 2.1.0__tar.gz

{renumerate-2.0.0 → renumerate-2.1.0}/CHANGES.rst

@@ -1,68 +1,72 @@
 Changelog
 =========
 
-2.0.0 (2025-09-08)
+2.1.0 (2026-01-20)
 ------------------
-- Mark the package as typed.
-- Setup (dependencies) update.
+- Marked the package as typed.
+- Copyright year update.
+- Switched from tox to Nox for project automation.
+- The documentation has been moved from Read the Docs to GitHub Pages.
+- Added the nox's 'cleanup' test environment.
+- Setup update (mainly dependencies) and bug fixes.
 
 1.5.0 (2025-09-01)
 ------------------
-- Making the package typed.
-- Setup (dependencies) update.
+- Made the package typed.
+- Setup update (mainly dependencies).
 
 1.3.5 (2025-07-07)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.3.4 (2025-06-11)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.3.3 (2025-05-15)
 ------------------
-- The distribution is now created using 'build' instead of 'setuptools'.
-- Setup (dependencies) update (due to regressions in tox and setuptools).
+- The distribution is now built using 'build' instead of 'setuptools'.
+- Setup update (mainly dependencies) (due to regressions in tox and setuptools).
 
 1.3.1 (2025-05-04)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.3.0 (2025-04-28)
 ------------------
-- Add support for Python 3.14
-- Drop support for Python 3.9 (due to compatibility issues).
-- Update readthedocs's python to version 3.13
-- Update tox's base_python to version 3.13
-- Setup (dependencies) update.
+- Added support for Python 3.14
+- Dropped support for Python 3.9 (due to compatibility issues).
+- Updated Read the Docs' Python version to 3.13
+- Updated tox's base_python to version 3.13
+- Setup update (mainly dependencies).
 
 1.2.11 (2025-03-20)
 -------------------
-- Add support for PyPy 3.11
-- Drop support for PyPy 3.9
-- Setup (dependencies) update.
+- Added support for PyPy 3.11
+- Dropped support for PyPy 3.9
+- Setup update (mainly dependencies).
 
 1.2.8 (2025-03-15)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.7 (2025-02-14)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.6 (2025-01-25)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.5 (2025-01-20)
 ------------------
 - Copyright year update.
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.4 (2024-12-13)
 ------------------
 - Source distribution (\*.tar.gz now) is compliant with PEP-0625.
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.3 (2024-11-13)
 ------------------
@@ -70,21 +74,21 @@ Changelog
 - 100% code linting.
 - 100% code coverage.
 - Tox configuration is now in native (toml) format.
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.2 (2024-10-30)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.1 (2024-10-09)
 ------------------
-- Drop support for Python 3.8
-- Setup (dependencies) update.
+- Dropped support for Python 3.8
+- Setup update (mainly dependencies).
 
 1.1.14 (2024-08-13)
 -------------------
-- Add support for Python 3.13
-- Setup (dependencies) update.
+- Added support for Python 3.13
+- Setup update (mainly dependencies).
 
 1.1.12 (2024-01-26)
 -------------------
@@ -93,16 +97,16 @@ Changelog
 
 1.1.10 (2022-10-18)
 -------------------
-- Tox configuration has been moved to pyproject.toml
+- The tox configuration has been moved to pyproject.toml
 
 1.1.9 (2022-08-22)
 ------------------
-- Add support for Python 3.10 and 3.11
+- Added support for Python 3.10 and 3.11
 - Setup update (currently based mainly on pyproject.toml).
 
 1.1.7 (2022-01-10)
 ------------------
-- Drop support for Python 3.6.
+- Dropped support for Python 3.6.
 - Copyright year update.
 - Setup update.
 
@@ -112,20 +116,20 @@ Changelog
 
 1.1.4 (2020-10-18)
 ------------------
-- Drop support for Python 3.5.
+- Dropped support for Python 3.5.
 - Add unittests.
 - Fixed docs setup.
 
 1.0.13 (2020-09-22)
 -------------------
-- Add support for Python 3.8 and 3.9.
-- Drop support for Python 3.4.
+- Added support for Python 3.8 and 3.9.
+- Dropped support for Python 3.4.
 - Setup: fix an improper dependencies versions.
 - Setup general update and cleanup.
 
 1.0.9 (2019-05-22)
 ------------------
-- Drop support for Python 2.
+- Dropped support for Python 2.
 
 1.0.8 (2019-05-21)
 ------------------
@@ -135,7 +139,7 @@ Changelog
 
 1.0.7 (2018-11-08)
 ------------------
-- Drop support for Python 2.6 and 3.0-3.3.
+- Dropped support for Python 2.6 and 3.0-3.3.
 - Update required setuptools version.
 
 1.0.6 (2018-05-08)

{renumerate-2.0.0 → renumerate-2.1.0}/LICENSE

@@ -1,6 +1,6 @@
 zlib License
 
-Copyright (C) 2016-2025 Adam Karpierz
+Copyright (C) 2016-2026 Adam Karpierz
 
 This software is provided 'as-is', without any express or implied
 warranty.  In no event will the authors be held liable for any damages

{renumerate-2.0.0 → renumerate-2.1.0}/MANIFEST.in

@@ -5,7 +5,7 @@ include README.rst
 include CHANGES.rst
 include LICENSE
 include pyproject.toml
-include .readthedocs.yml
+include noxfile.py
 
 graft docs
 

renumerate-2.1.0/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.4
+Name: renumerate
+Version: 2.1.0
+Summary: Reverse enumerate.
+Author-email: Adam Karpierz <adam@karpierz.net>
+Maintainer-email: Adam Karpierz <adam@karpierz.net>
+License-Expression: Zlib
+Project-URL: Homepage, https://pypi.org/project/renumerate/
+Project-URL: Documentation, https://karpierz.github.io/renumerate/
+Project-URL: History, https://karpierz.github.io/renumerate/CHANGES.html
+Project-URL: Download, https://pypi.org/project/renumerate/
+Project-URL: Repository, https://github.com/karpierz/renumerate
+Project-URL: Tracker, https://github.com/karpierz/renumerate/issues
+Project-URL: Sponsoring, https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
+Keywords: renumerate,enumerate
+Platform: any
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: Polish
+Classifier: Programming Language :: Python
+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
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <4.0.0,>=3.10.0
+Description-Content-Type: text/x-rst; charset=UTF-8
+License-File: LICENSE
+Requires-Dist: typing-extensions>=4.15.0
+Requires-Dist: pkg-about>=2.1.0
+Dynamic: license-file
+
+renumerate
+==========
+
+Reverse enumerate.
+
+Overview
+========
+
+**renumerate(sequence, start=len(sequence)-1, end=0)**
+
+| Return an enumerate_ object.
+| *sequence* must be an object that has a __reversed__() method or supports the
+  sequence protocol (the __len__() method and the __getitem__() method with
+  integer arguments starting at 0).
+| The __next__() method of the iterator returned by renumerate() returns a tuple
+  containing a count (from *start* which defaults to len(*sequence*) - 1 or ends at
+  *end* which defaults to 0 - but not both) and the values obtained from reverse
+  iterating over *sequence*.
+
+`PyPI record`_.
+
+`Documentation`_.
+
+Usage
+-----
+
+.. code:: python
+
+  >>> from renumerate import renumerate
+  >>> seasons = ['Spring', 'Summer', 'Fall', 'Winter']
+  >>> list(renumerate(seasons))
+  [(3, 'Winter'), (2, 'Fall'), (1, 'Summer'), (0, 'Spring')]
+  >>> list(renumerate(seasons, start=4))
+  [(4, 'Winter'), (3, 'Fall'), (2, 'Summer'), (1, 'Spring')]
+  >>> list(renumerate(seasons, end=2))
+  [(5, 'Winter'), (4, 'Fall'), (3, 'Summer'), (2, 'Spring')]
+
+Equivalent to:
+
+.. code:: python
+
+  def renumerate(sequence, start=None, end=None):
+      if start is not None and end is not None:
+          raise TypeError("renumerate() only accepts start argument or end argument"
+                          " - not both.")
+      if start is None: start = len(sequence) - 1
+      if end   is None: end   = 0
+      n = start + end
+      for elem in reversed(sequence):
+          yield n, elem
+          n -= 1
+
+Installation
+============
+
+Prerequisites:
+
++ Python 3.10 or higher
+
+  * https://www.python.org/
+
++ pip
+
+  * https://pypi.org/project/pip/
+
+To install run:
+
+  .. parsed-literal::
+
+    python -m pip install --upgrade |package|
+
+Development
+===========
+
+Prerequisites:
+
++ Development is strictly based on *nox*. To install it run::
+
+    python -m pip install --upgrade nox
+
+Visit `Development page`_.
+
+Installation from sources:
+
+clone the sources:
+
+  .. parsed-literal::
+
+    git clone |respository| |package|
+
+and run:
+
+  .. parsed-literal::
+
+    python -m pip install ./|package|
+
+or on development mode:
+
+  .. parsed-literal::
+
+    python -m pip install --editable ./|package|
+
+License
+=======
+
+  | |copyright|
+  | Licensed under the zlib/libpng License
+  | https://opensource.org/license/zlib
+  | Please refer to the accompanying LICENSE file.
+
+Authors
+=======
+
+* Adam Karpierz <adam@karpierz.net>
+
+Sponsoring
+==========
+
+| If you would like to sponsor the development of this project, your contribution
+  is greatly appreciated.
+| As I am now retired, any support helps me dedicate more time to maintaining and
+  improving this work.
+
+`Donate`_
+
+.. |package| replace:: renumerate
+.. |package_bold| replace:: **renumerate**
+.. |copyright| replace:: Copyright (c) 2016-2026 Adam Karpierz
+.. |respository| replace:: https://github.com/karpierz/renumerate
+.. _Development page: https://github.com/karpierz/renumerate
+.. _PyPI record: https://pypi.org/project/renumerate/
+.. _Documentation: https://karpierz.github.io/renumerate/
+.. _Donate: https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
+.. _enumerate: https://docs.python.org/library/functions.html#enumerate

{renumerate-2.0.0 → renumerate-2.1.0}/README.rst

@@ -6,7 +6,7 @@ Reverse enumerate.
 Overview
 ========
 
-**renumerate(sequence, start=len(sequence)-1, end=0):**
+**renumerate(sequence, start=len(sequence)-1, end=0)**
 
 | Return an enumerate_ object.
 | *sequence* must be an object that has a __reversed__() method or supports the
@@ -59,10 +59,9 @@ Prerequisites:
 
   * https://www.python.org/
 
-+ pip and setuptools
++ pip
 
   * https://pypi.org/project/pip/
-  * https://pypi.org/project/setuptools/
 
 To install run:
 
@@ -75,9 +74,9 @@ Development
 
 Prerequisites:
 
-+ Development is strictly based on *tox*. To install it run::
++ Development is strictly based on *nox*. To install it run::
 
-    python -m pip install --upgrade tox
+    python -m pip install --upgrade nox
 
 Visit `Development page`_.
 
@@ -114,11 +113,22 @@ Authors
 
 * Adam Karpierz <adam@karpierz.net>
 
+Sponsoring
+==========
+
+| If you would like to sponsor the development of this project, your contribution
+  is greatly appreciated.
+| As I am now retired, any support helps me dedicate more time to maintaining and
+  improving this work.
+
+`Donate`_
+
 .. |package| replace:: renumerate
 .. |package_bold| replace:: **renumerate**
-.. |copyright| replace:: Copyright (c) 2016-2025 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/renumerate.git
+.. |copyright| replace:: Copyright (c) 2016-2026 Adam Karpierz
+.. |respository| replace:: https://github.com/karpierz/renumerate
 .. _Development page: https://github.com/karpierz/renumerate
 .. _PyPI record: https://pypi.org/project/renumerate/
-.. _Documentation: https://renumerate.readthedocs.io/
+.. _Documentation: https://karpierz.github.io/renumerate/
+.. _Donate: https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
 .. _enumerate: https://docs.python.org/library/functions.html#enumerate

{renumerate-2.0.0 → renumerate-2.1.0}/docs/conf.py

@@ -4,9 +4,11 @@
 # list see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+import os
+
 from sphinx import application
 
-about = __import__("pkg_about").about_from_setup()
+about = __import__("pkg_about").about_from_setup(1)
 
 def setup(app: application.Sphinx) -> None:
     pass
@@ -115,3 +117,10 @@ apidoc_output_dir = 'api'
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
+
+# -- Options for linkcheck extension -----------------------------------------
+
+linkcheck_ignore = []
+doc_url = about.__urls__.get("Documentation")
+if doc_url is not None and os.getenv("PKG_INITIAL_BUILD") == "1":
+    linkcheck_ignore += [rf"{doc_url.rstrip('/')}(/.*)?"]

{renumerate-2.0.0 → renumerate-2.1.0}/docs/index.rst

@@ -10,6 +10,9 @@ Contents
 .. toctree::
    :maxdepth: 2
 
+.. toctree::
+   :titlesonly:
+
    CHANGES.rst
 
 Indices and tables

renumerate-2.1.0/noxfile.py

@@ -0,0 +1,159 @@
+# Copyright (c) 2025 Adam Karpierz
+# SPDX-License-Identifier: Zlib
+
+# /// script
+# dependencies = ["nox>=2025.11.12", "packaging>=26.0.0"]
+# ///
+
+from __future__ import annotations
+
+from typing import Any
+import sys
+import os
+from pathlib import Path
+from functools import partial
+import shutil
+import subprocess
+import warnings
+
+import nox
+import nox_ext
+import packaging.version
+from rich.pretty import pprint
+from rich import print
+
+here = Path(__file__).resolve().parent
+env  = os.environ
+
+# Configuration
+
+PKG = nox.get_package_data(here)
+
+PYPROJECT   = nox.project.load_toml("pyproject.toml")
+PY_VERSIONS = nox.project.python_versions(PYPROJECT)
+PY_DEFAULT  = "3.13"
+
+PKG_TOP_LEVELS = ["renumerate"]
+
+# Prevent Python from writing bytecode
+env["PYTHONDONTWRITEBYTECODE"] = "1"
+# env["PKG_INITIAL_BUILD"] = "1"
+
+# Helpers & Utils
+
+copytree = shutil.copytree
+rmtree   = partial(shutil.rmtree, ignore_errors=True)
+
+# Sessions
+
+@nox.session(python=[PY_DEFAULT], default=False,
+    tags=["prepare"], requires=["cleanup"])
+def prepare(session: nox.Session) -> None:
+    """Preparing the repository"""
+    cmd = here/".aprep.cmd"
+    if cmd.is_file(): subprocess.run([cmd])
+
+@nox.session(python=[PY_DEFAULT], default=False,
+    tags=["cleanup"])
+def cleanup(session: nox.Session) -> None:
+    """Cleaning the repository"""
+#no_package = true
+    cmd = here/".clean.cmd"
+    if cmd.is_file(): subprocess.run([cmd], stderr=subprocess.DEVNULL)
+    rmtree(here/"build")
+    rmtree(here/"dist"),
+    for item in here.glob("src/*.egg-info"): rmtree(item)
+    for item in here.glob("**/__pycache__"): rmtree(item)
+    for item in here.glob("**/.mypy_cache"): rmtree(item)
+    rmtree(here/".tox")
+    rmtree(here/".nox")
+
+@nox.session(python=[*PY_VERSIONS, "pypy3.10", "pypy3.11"])
+def tests(session: nox.Session) -> None:
+    """Running tests"""
+    session.install(".", "--group=test")
+    session.py("--version")
+    session.py("-m", "tests", *session.posargs)
+
+@nox.session(python=[PY_DEFAULT],
+    tags=["coverage"])
+def coverage(session: nox.Session) -> None:
+    """Running code coverage analysis"""
+    session.install(".", "--group=coverage")
+    session.py("-m", "coverage", "erase")
+    session.py("-m", "coverage", "run", "-m", "tests", *session.posargs, success_codes=range(0, 256))
+    session.py("-m", "coverage", "html", success_codes=range(0, 256))
+    session.py("-m", "coverage", "report")
+
+@nox.session(python=[PY_DEFAULT],
+    tags=["docs"])
+def docs(session: nox.Session) -> None:
+    """Building documentation and running doc tests"""
+    session.install(".", "--group=docs")
+    html_path = here/"build/docs/html"
+    session.py("-m", "sphinxlint", "-i", "#arch", "-i", ".nox", "-i", ".tox",
+                                   "-i", "build", "-i", "dist", "-i", ".mypy_cache")
+    #session.run("python","-m", "sphinx.apidoc", "-f", *[session.site_packages/f"{item}/"
+    #                                                    for item in PKG_TOP_LEVELS])
+    session.py("-m", "sphinx.cmd.build", "-W", "-a", "-b", "html", "-E", here/"docs", here/"build/docs/html")
+    session.py("-m", "sphinx.cmd.build", "-W", "-a", "-b", "doctest",    here/"docs", here/"build/docs/html")
+    session.py("-m", "sphinx.cmd.build", "-W", "-a", "-b", "linkcheck",  here/"docs", here/"build/docs/html")
+
+@nox.session(python=[PY_DEFAULT], default=False,
+    tags=["build"], requires=[f"{tests.name}-{item}" for item in tests.python] + ["docs"])
+def build(session: nox.Session) -> None:
+    """Building the package"""
+    session.install("--group=build")
+    session.py("-m", "check_manifest", "-v")
+    session.py("-m", "build")
+    # Verify distribution files
+    session.py("-m", "twine", "check", "dist/*")
+
+@nox.session(python=[PY_DEFAULT], default=False,
+    tags=["publish"], requires=["build"])
+def publish(session: nox.Session) -> None:
+    """Publishing the package and documentation"""
+    session.install("--group=publish")
+    # Publish on PyPI
+    session.py("-m", "twine", "upload", "dist/*")
+    # Publish documentation on GitHub Pages
+    # checkout gh-pages worktree
+    env_dir = Path(session.virtualenv.location)
+    gh_pages_dir = env_dir/"gh-pages"
+    rmtree(gh_pages_dir)
+    session.run("git", "worktree", "prune")
+    #session.run("git", "worktree", "add", gh_pages_dir, "gh-pages")
+    session.run("git", "worktree", "add", "-B", "gh-pages", gh_pages_dir)
+    # clean old docs
+    (gh_pages_dir/".nojekyll").touch()
+    for fpath in gh_pages_dir.iterdir():
+        if fpath.name not in (".git",".nojekyll"):
+            if fpath.is_dir():
+                rmtree(fpath)
+            else:
+                fpath.unlink(missing_ok=True)
+    # copy new docs
+    copytree(here/"build/docs/html", gh_pages_dir, dirs_exist_ok=True)
+    # commit + push
+    session.run("git", "-C", gh_pages_dir, "add", ".")
+    session.run("git", "-C", gh_pages_dir, "commit", "-m", "Update documentation")
+    session.run("git", "-C", gh_pages_dir, "push", "--force", "origin", "gh-pages")
+    # remove worktree
+    session.run("git", "worktree", "remove", "--force", gh_pages_dir)
+    rmtree(gh_pages_dir)
+    session.run("git", "worktree", "prune")
+
+@nox.session(python=[PY_DEFAULT],
+    tags=["typing"])
+def typing(session: nox.Session) -> None:
+    """Static type checking"""
+    session.install(".", "--group=typing")
+    session.py("-m", "mypy")
+
+@nox.session(python=[PY_DEFAULT],
+    tags=["lint"])
+def lint(session: nox.Session) -> None:
+    """Checking code style and quality"""
+    session.install(".", "--group=lint")
+    session.py("-m", "flake8", *[session.site_packages/f"{item}/"
+                                 for item in PKG_TOP_LEVELS])