annotate 2.0.8__tar.gz → 2.1.0__tar.gz

{annotate-2.0.8 → annotate-2.1.0}/CHANGES.rst

@@ -1,81 +1,84 @@
 Changelog
 =========
 
-2.0.8 (2025-11-30)
+2.1.0 (2026-01-20)
 ------------------
-- Mark the package as typed.
+- Marked the package as typed.
 - 100% code coverage.
-- Add tox's tool.tox.env.cleanup testenv.
-- Setup (dependencies) update.
+- 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.3.0 (2025-09-01)
 ------------------
-- Making the package typed.
-- Setup (dependencies) update.
+- Made the package typed.
+- Setup update (mainly dependencies).
 
 1.2.4 (2025-07-07)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.3 (2025-06-11)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.2 (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.2.1 (2025-05-04)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.2.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.1.5 (2025-02-14)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.1.4 (2025-01-25)
 ------------------
 - Copyright year update.
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.1.3 (2024-12-13)
 ------------------
 - Source distribution (\*.tar.gz now) is compliant with PEP-0625.
 - 100% code linting.
 - Tox configuration is now in native (toml) format.
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.1.2 (2024-10-30)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.1.1 (2024-10-09)
 ------------------
-- Setup (dependencies) update.
+- Setup update (mainly dependencies).
 
 1.1.0 (2024-09-30)
 ------------------
-- Drop support for Python 3.8
-- Setup (dependencies) update.
+- Dropped support for Python 3.8
+- Setup update (mainly dependencies).
 
 1.0.20 (2024-08-13)
 -------------------
-- Add support for Python 3.12 and 3.13
-- Drop support for Python 3.7
-- Setup (dependencies) update.
+- Added support for Python 3.12 and 3.13
+- Dropped support for Python 3.7
+- Setup update (mainly dependencies).
 
 1.0.19 (2022-10-18)
 -------------------
-- Tox configuration has been moved to pyproject.toml
+- The tox configuration has been moved to pyproject.toml
 
 1.0.18 (2022-08-22)
 -------------------
@@ -83,12 +86,12 @@ Changelog
 
 1.0.17 (2022-07-24)
 -------------------
-- 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.0.16 (2022-01-10)
 -------------------
-- Drop support for Python 2, 3.5 and 3.6
+- Dropped support for Python 2, 3.5 and 3.6
 - Copyright year update.
 - Setup update.
 
@@ -105,7 +108,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)

{annotate-2.0.8 → annotate-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
 

{annotate-2.0.8 → annotate-2.1.0}/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.4
 Name: annotate
-Version: 2.0.8
+Version: 2.1.0
 Summary: Decorator to set a function's __annotations__ like Py3.
 Author-email: Adam Karpierz <adam@karpierz.net>
 Maintainer-email: Adam Karpierz <adam@karpierz.net>
 License-Expression: Zlib
 Project-URL: Homepage, https://pypi.org/project/annotate/
-Project-URL: Documentation, https://annotate2.readthedocs.io/
+Project-URL: Documentation, https://karpierz.github.io/annotate/
+Project-URL: History, https://karpierz.github.io/annotate/CHANGES.html
 Project-URL: Download, https://pypi.org/project/annotate/
-Project-URL: Source, https://github.com/karpierz/annotate
-Project-URL: Issues, https://github.com/karpierz/annotate/issues
+Project-URL: Repository, https://github.com/karpierz/annotate
+Project-URL: Tracker, https://github.com/karpierz/annotate/issues
+Project-URL: Sponsoring, https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S
 Keywords: annotate,typing,decorator
 Platform: any
 Classifier: Development Status :: 5 - Production/Stable
@@ -31,22 +33,8 @@ 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: setuptools>=80.9.0
 Requires-Dist: typing-extensions>=4.15.0
-Requires-Dist: pkg-about>=2.0.0
-Provides-Extra: doc
-Requires-Dist: sphinx>=8.1.3; extra == "doc"
-Requires-Dist: sphinx-autodoc-typehints>=3.0.1; extra == "doc"
-Requires-Dist: sphinx-toolbox>=4.0.0; extra == "doc"
-Requires-Dist: sphinx-tabs>=3.4.5; extra == "doc"
-Requires-Dist: sphinx-copybutton>=0.5.2; extra == "doc"
-Requires-Dist: sphinxcontrib-spelling>=8.0.2; extra == "doc"
-Requires-Dist: sphinx-lint>=1.0.2; extra == "doc"
-Requires-Dist: restructuredtext-lint>=2.0.2; extra == "doc"
-Requires-Dist: nbsphinx>=0.9.8; extra == "doc"
-Provides-Extra: test
-Requires-Dist: deepdiff>=8.6.1; extra == "test"
-Requires-Dist: rich>=14.2.0; extra == "test"
+Requires-Dist: pkg-about>=2.1.0
 Dynamic: license-file
 
 annotate
@@ -74,9 +62,9 @@ Examples
   from typing   import Optional, Tuple, Union, Sequence
   from annotate import annotate
 
-  from .lib import cached
-  from .    import jni
+  import jni
 
+  from .lib         import cached
   from .jobjectbase import JObjectBase
   from .jclass      import JClass
   from .jobject     import JObject
@@ -222,10 +210,9 @@ Prerequisites:
 
   * https://www.python.org/
 
-+ pip and setuptools
++ pip
 
   * https://pypi.org/project/pip/
-  * https://pypi.org/project/setuptools/
 
 To install run:
 
@@ -238,9 +225,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`_.
 
@@ -277,204 +264,21 @@ 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:: annotate
 .. |package_bold| replace:: **annotate**
 .. |copyright| replace:: Copyright (c) 2012-2026 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/annotate.git
+.. |respository| replace:: https://github.com/karpierz/annotate
 .. _Development page: https://github.com/karpierz/annotate
 .. _PyPI record: https://pypi.org/project/annotate/
-.. _Documentation: https://annotate.readthedocs.io/
-
-Changelog
-=========
-
-2.0.8 (2025-11-30)
-------------------
-- Mark the package as typed.
-- 100% code coverage.
-- Add tox's tool.tox.env.cleanup testenv.
-- Setup (dependencies) update.
-
-1.3.0 (2025-09-01)
-------------------
-- Making the package typed.
-- Setup (dependencies) update.
-
-1.2.4 (2025-07-07)
-------------------
-- Setup (dependencies) update.
-
-1.2.3 (2025-06-11)
-------------------
-- Setup (dependencies) update.
-
-1.2.2 (2025-05-15)
-------------------
-- The distribution is now created using 'build' instead of 'setuptools'.
-- Setup (dependencies) update (due to regressions in tox and setuptools).
-
-1.2.1 (2025-05-04)
-------------------
-- Setup (dependencies) update.
-
-1.2.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.
-
-1.1.5 (2025-02-14)
-------------------
-- Setup (dependencies) update.
-
-1.1.4 (2025-01-25)
-------------------
-- Copyright year update.
-- Setup (dependencies) update.
-
-1.1.3 (2024-12-13)
-------------------
-- Source distribution (\*.tar.gz now) is compliant with PEP-0625.
-- 100% code linting.
-- Tox configuration is now in native (toml) format.
-- Setup (dependencies) update.
-
-1.1.2 (2024-10-30)
-------------------
-- Setup (dependencies) update.
-
-1.1.1 (2024-10-09)
-------------------
-- Setup (dependencies) update.
-
-1.1.0 (2024-09-30)
-------------------
-- Drop support for Python 3.8
-- Setup (dependencies) update.
-
-1.0.20 (2024-08-13)
--------------------
-- Add support for Python 3.12 and 3.13
-- Drop support for Python 3.7
-- Setup (dependencies) update.
-
-1.0.19 (2022-10-18)
--------------------
-- Tox configuration has been moved to pyproject.toml
-
-1.0.18 (2022-08-22)
--------------------
-- Setup update.
-
-1.0.17 (2022-07-24)
--------------------
-- Add support for Python 3.10 and 3.11
-- Setup update (currently based mainly on pyproject.toml).
-
-1.0.16 (2022-01-10)
--------------------
-- Drop support for Python 2, 3.5 and 3.6
-- Copyright year update.
-- Setup update.
-
-1.0.15 (2020-10-18)
--------------------
-- Setup: fix an improper dependencies versions.
-- Setup general update and cleanup.
-- Fixed docs setup.
-
-1.0.8 (2019-05-21)
-------------------
-- Update required setuptools version.
-- Setup update and improvements.
-
-1.0.7 (2018-11-08)
-------------------
-- Drop support for Python 2.6 and 3.0-3.3
-- Update required setuptools version.
-
-1.0.6 (2018-05-08)
-------------------
-- Update required setuptools version.
-- Improve and simplify setup and packaging.
-
-1.0.5 (2018-02-26)
-------------------
-- Improve and simplify setup and packaging.
-
-1.0.4 (2018-01-28)
-------------------
-- Fix a bug and inconsistencies in tox.ini
-- Update of README.rst.
-
-1.0.1 (2018-01-24)
-------------------
-- Update required Sphinx version.
-- Update doc Sphinx configuration files.
-
-1.0.0 (2017-11-18)
-------------------
-- Setup improvements.
-- Other minor improvements.
-
-0.7.4 (2017-01-05)
-------------------
-- Minor setup improvements.
-
-0.7.3 (2016-09-25)
-------------------
-- Fix bug in setup.py
-
-0.7.1 (2016-09-25)
-------------------
-- More PEP8 compliant
-
-0.6.7 (2016-09-24)
-------------------
-- Minor description suplement
-
-0.6.4 (2016-09-23)
-------------------
-- Simplify package structure.
-
-0.6.3 (2016-06-19)
-------------------
-- | Fix incompatibility for older versions of setuptools.
-  | Add example.
-
-0.6.0 (2015-08-17)
-------------------
-- Python3 support.
-
-0.5.1 (2015-02-27)
-------------------
-- | Remove 'returns' as keyword argument for declare return type.
-  | For now, the type of returned value should be declared by the
-  | first positional argument.
-
-0.3.3 (2014-09-15)
-------------------
-- Add wheels.
-
-0.3.2 (2014-09-13)
-------------------
-- Standarize package.
-
-0.3.0 (2014-09-06)
-------------------
-- Standarize package.
-- Cosmetic changes.
-
-0.2.6 (2014-06-10)
-------------------
-- Portable setup.py.
-
-0.2.5 (2014-06-10)
-------------------
-- Cosmetic changes.
-
-0.2.3 (2012-10-13)
-------------------
-- Initial release.
+.. _Documentation: https://karpierz.github.io/annotate/
+.. _Donate: https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S

{annotate-2.0.8 → annotate-2.1.0}/README.rst

@@ -23,9 +23,9 @@ Examples
   from typing   import Optional, Tuple, Union, Sequence
   from annotate import annotate
 
-  from .lib import cached
-  from .    import jni
+  import jni
 
+  from .lib         import cached
   from .jobjectbase import JObjectBase
   from .jclass      import JClass
   from .jobject     import JObject
@@ -171,10 +171,9 @@ Prerequisites:
 
   * https://www.python.org/
 
-+ pip and setuptools
++ pip
 
   * https://pypi.org/project/pip/
-  * https://pypi.org/project/setuptools/
 
 To install run:
 
@@ -187,9 +186,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`_.
 
@@ -226,10 +225,21 @@ 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:: annotate
 .. |package_bold| replace:: **annotate**
 .. |copyright| replace:: Copyright (c) 2012-2026 Adam Karpierz
-.. |respository| replace:: https://github.com/karpierz/annotate.git
+.. |respository| replace:: https://github.com/karpierz/annotate
 .. _Development page: https://github.com/karpierz/annotate
 .. _PyPI record: https://pypi.org/project/annotate/
-.. _Documentation: https://annotate.readthedocs.io/
+.. _Documentation: https://karpierz.github.io/annotate/
+.. _Donate: https://www.paypal.com/donate/?hosted_button_id=FX8L7CJUGLW7S

{annotate-2.0.8 → annotate-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('/')}(/.*)?"]

{annotate-2.0.8 → annotate-2.1.0}/docs/index.rst

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

annotate-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 = ["annotate"]
+
+# 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])