pythonic-fp-gadgets 4.1.0__tar.gz → 4.2.0__tar.gz

{pythonic_fp_gadgets-4.1.0 → pythonic_fp_gadgets-4.2.0}/PKG-INFO

@@ -1,11 +1,11 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: pythonic-fp-gadgets
-Version: 4.1.0
-Summary: Gadgets
+Version: 4.2.0
+Summary: Gadgets without external Pythonic FP dependencies.
 Keywords: gadgets
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
-Description-Content-Type: text/x-rst
+Description-Content-Type: text/markdown
 Classifier: Development Status :: 4 - Beta
 Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
@@ -14,46 +14,37 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pytest>=8.4.1 ; extra == "test"
-Requires-Dist: pythonic-fp-circulararray>=6.0.4 ; extra == "test"
-Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/projects/gadgets.html
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-gadgets/release/html/
 Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-gadgets
-Provides-Extra: test
+Import-Name: pythonic_fp.gadgets
+Import-Namespace: pythonic_fp
 
-Pythonic FP - Gadgets
-=====================
-
-PyPI project
-`pythonic-fp-gadgets
-<https://pypi.org/project/pythonic-fp-gadgets>`_.
+# Pythonic FP - Gadgets
 
 Library of simple, but useful, classes and functions with no dependencies
 outside the Python Standard Library.
 
-- Gadgets
+PyPI project
+[pythonic-fp-gadgets](https://pypi.org/project/pythonic-fp-gadgets).
+Part of the
+[pythonic-fp](https://grscheller.github.io/pythonic-fp/)
+PyPI projects.
+
+## Documentation
+
+Documentation and other links for this project are hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp/projects/gadgets.html).
 
+- Gadgets
   - single item box
   - immutable wrapped (hashable) references
   - function returning iterator of its arguments
   - function to find the latest common ancestor of two classes
   - sentinel values
 
-Part of the
-`pythonic-fp
-<https://grscheller.github.io/pythonic-fp/>`_
-PyPI projects.
-
-Documentation
--------------
-
-Documentation and other links for this project are hosted on
-`GitHub Pages
-<https://grscheller.github.io/pythonic-fp/projects/gadgets.html>`_.
-
-Copyright and License
----------------------
+## Copyright and License
 
 Copyright (c) 2025-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_gadgets-4.1.0/README.rst → pythonic_fp_gadgets-4.2.0/README.md

@@ -1,35 +1,27 @@
-Pythonic FP - Gadgets
-=====================
-
-PyPI project
-`pythonic-fp-gadgets
-<https://pypi.org/project/pythonic-fp-gadgets>`_.
+# Pythonic FP - Gadgets
 
 Library of simple, but useful, classes and functions with no dependencies
 outside the Python Standard Library.
 
-- Gadgets
+PyPI project
+[pythonic-fp-gadgets](https://pypi.org/project/pythonic-fp-gadgets).
+Part of the
+[pythonic-fp](https://grscheller.github.io/pythonic-fp/)
+PyPI projects.
+
+## Documentation
+
+Documentation and other links for this project are hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp/projects/gadgets.html).
 
+- Gadgets
   - single item box
   - immutable wrapped (hashable) references
   - function returning iterator of its arguments
   - function to find the latest common ancestor of two classes
   - sentinel values
 
-Part of the
-`pythonic-fp
-<https://grscheller.github.io/pythonic-fp/>`_
-PyPI projects.
-
-Documentation
--------------
-
-Documentation and other links for this project are hosted on
-`GitHub Pages
-<https://grscheller.github.io/pythonic-fp/projects/gadgets.html>`_.
-
-Copyright and License
----------------------
+## Copyright and License
 
 Copyright (c) 2025-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

{pythonic_fp_gadgets-4.1.0 → pythonic_fp_gadgets-4.2.0}/pyproject.toml

@@ -4,9 +4,10 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-gadgets"
-version = "4.1.0"
-readme = "README.rst"
-requires-python = ">=3.13"
+version = "4.2.0"
+description = "Gadgets without external Pythonic FP dependencies."
+readme = "README.md"
+requires-python = ">=3.13"  # syntactic floor: known to SyntaxError below this
 authors = [
   { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
 ]
@@ -19,27 +20,43 @@ classifiers = [
   "Intended Audience :: Developers",
   "License :: OSI Approved :: Apache Software License",
   "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.14",  # tested: pytest test suite successful
   "Typing :: Typed",
 ]
 dependencies = []
-dynamic = ["description"]
 
 [project.urls]
-Changelog = "https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/projects/gadgets.html"
+Changelog = "https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.md"
+Documentation ="https://grscheller.github.io/pythonic-fp-gadgets/release/html/"
 Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-gadgets"
 
-[project.optional-dependencies]
+[dependency-groups]
+docs = [
+  "furo>=2025.12.19",
+  "sphinx>=9.1",
+]
+pub = [
+  "flit",
+]
 test = [
   "pytest>=8.4.1",
-  "pythonic-fp-circulararray>=6.0.4",
 ]
 
 [tool.flit.module]
 name = "pythonic_fp.gadgets"
 
+[tool.flit.sdist]
+exclude = [
+  "docs/",
+  "tests/",
+]
+
+[tool.pytest]
+addopts = ["-ra"]
+consider_namespace_packages = true
+testpaths = ["tests/"]
+
 [tool.mypy]
 explicit_package_bases = true
 local_partial_types = true
@@ -48,23 +65,12 @@ warn_redundant_casts = true
 warn_return_any = true
 warn_unused_configs = true
 
-[tool.pylsp-mypy]
-enabled = true
-live-mode = true
-dmypy = false
-strict = true
-report_progress = true
-
-[tool.pytest]
-addopts = [
-  "-ra",
-]
-consider_namespace_packages = true
-testpaths = ["tests/"]
-
 [tool.ruff]
 target-version = "py314"
 
+[tool.ruff.lint]
+ignore = ["RUF022", "E741"]
+
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
@@ -73,7 +79,6 @@ docstring-quotes = "double"
   "E731",
   "C901",
 ]
-"**/*.py" = ["E741"]
 
 [tool.ruff.format]
 quote-style = "single"

pythonic_fp_gadgets-4.1.0/.github/workflows/static.yml

@@ -1,64 +0,0 @@
-name: Build and Deploy Furo Themed Sphinx Documentation
-
-on:
-  push:
-    branches: ["main"]
-  workflow_dispatch:
-
-env:
-  RELEASE: '4.1.0'
-  DEVEL: '4.1.1'
-  PYTHON: '3.14'
-
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-concurrency:
-  group: "pages"
-  cancel-in-progress: false
-
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v6
-
-      - name: Select Python
-        uses: actions/setup-python@v6
-        with:
-          python-version: ${{ env.PYTHON }}
-
-      - name: Install Sphinx Dependencies
-        run: |
-          pip install -r docs/requirements.txt
-          sudo apt-get install -y graphviz
-
-      - name: Build Release Docs
-        run: |
-          pip install pythonic-fp-gadgets
-          docs/gen_conf.py release ${{ env.RELEASE }} Gadgets gadgets > docs/source/conf.py
-          sphinx-build -M html docs/source docs/build/release
-
-      - name: Build Development Docs
-        run: |
-          pip install -e .
-          docs/gen_conf.py devel ${{ env.DEVEL }} Gadgets gadgets > docs/source/conf.py
-          sphinx-build -M html docs/source docs/build/development
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v6
-
-      - name: Upload Artifact
-        uses: actions/upload-pages-artifact@v5
-        with:
-          path: docs/build
-
-      - name: Deploy to GitHub Pages
-        uses: actions/deploy-pages@v5
-        id: deployment

pythonic_fp_gadgets-4.1.0/.gitignore

@@ -1,9 +0,0 @@
-# Minimal version - only add to when necessary
-**/__pycache__/
-dist/
-docs/build/
-docs/source/conf.py
-**/.dmypy.json
-**/.mypy_cache/
-**/.pytest_cache/
-**/.ruff_cache

pythonic_fp_gadgets-4.1.0/CHANGELOG.rst

@@ -1,117 +0,0 @@
-CHANGELOG
-=========
-
-PyPI pythonic-fp-gadgets project.
-
-Semantic Versioning
--------------------
-
-Strict 3 digit semantic versioning
-
-- **MAJOR** version incremented for incompatible API changes
-- **MINOR** version incremented for backward compatible added functionality
-- **PATCH** version incremented for backward compatible bug fixes
-
-See `Semantic Versioning 2.0.0 <https://semver.org>`_.
-
-Releases and Important Milestones
----------------------------------
-
-PyPI 4.1.0 - 2026-05-12
-~~~~~~~~~~~~~~~~~~~~~~~
-
-- documentation now in maintenance mode
-- development status now "4 - Beta"
-- added a few missing methods
-
-PyPI 4.0.4 - 2026-04-26
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Much docstring work for sentinels. Need to push now to fix
-broken links on PyPI before going into documentation maintenance.
-
-Development Status Reappraisal - 2026-05-05
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Maintainer appraised the Development Status for
-pythonic-fp-gadgets to be "3 - Alpha".
-
-PyPI 4.0.3 - 2026-04-26
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Redoing docs based on circulararray and booleans.
-
-- made some innovations which I will back port to the above two.
-
-
-PyPI 4.0.2 - 2026-01-08
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Docstring improvements based on lessons learned from my PyPI
-boring-math-abstract-algebra project.
-
-PyPI v4.0.1 - 2025-12-02
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Move functions out of their own packages to __init__.py (2025-10-13).
-
-- latest_common_ancestor.lca -> first_common_ancestor
-- iterate_arguments.ita -> iterate_over_arguments
-
-Unfortunately I forgot to push these changes to PyPI for a
-month and a half!
-
-PyPI v3.0.1 - 2025-09-09
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Corrected incorrect dependencies.
-
-PyPI v3.0.0 - 2025-08-31
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Discovered I was not quite compliant with
-Python typing 3.12+ conventions.
-
-- No longer explicitly using TypeVar directly.
-
-  - Removed Unions with Never from .py files
-
-    - the "happy path" returns just types (pythonic convention)
-    - stubgen actually puts them back in .pyi files
-
-- renamed it.it -> iterate_arguments.ita
-- renamed lca.latest_common_ancestor -> latest_common_ancestor.lca
-
-PyPI v2.2.0 - 2025-08-30
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Moved for pythonic_fp.gadgets package to a new GitHub repo,
-pythonic-fp-gadgets. Replaced it with the empty Python
-module pythonic_fp.name_claim in pythonic-fp.
-
-The gadgets package being different from the other namespace
-packages was throwing off my workflow.
-
-- added function it.it
-- added function lca.latest_common_ancestor
-
-Update - 2025-08-09
-~~~~~~~~~~~~~~~~~~~
-
-Preparing for upcoming PyPI release for gadgets.
-
-- decided to make gadget's pyproject.toml the exemplar for rest of pythonic-fp namespace
-- pythonic_fp.gadget works with previous and next release of singletons
-
-PyPI v1.1.0 - 2025-08-02
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Released pythonic-fp v1.1.0 which contains pythonic_fp.gadgets package.
-
-Update - 2025-08-01
-~~~~~~~~~~~~~~~~~~~
-
-Added package pythonic_fp.gadgets to the "name-claim" PyPI
-project pythonic-fp. The gadgets library is for simple,
-but useful, functions and data structures with minimal
-dependencies.

pythonic_fp_gadgets-4.1.0/docs/Makefile

@@ -1,78 +0,0 @@
-# Makefile for Sphinx documentation
-
-# Last and future releases
-#  - former needs to agree with PyPI
-#  - later needs to agree with pyproject.toml
-PROJECT_NAME = Gadgets
-PYPI_NAME = gadgets
-RELEASE_VERSION = 4.1.0
-DEVEL_VERSION = 4.1.1
-CUSTOM_VERSION = 0.0.0
-
-SPHINXOPTS ?=
-SPHINXBUILD ?= sphinx-build
-SOURCEDIR = source
-BUILDDIR = build
-
-STATICDIR = source/_static
-TEMPLATEDIR = source/_templates
-
-# Put help first so that "make" without argument is like "make help".
-help:
-	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
-
-clean_source:
-	@rm -f "$(SOURCEDIR)"/conf.py
-
-clean_devel:
-	@rm -rf "$(BUILDDIR)"/development
-
-clean_release:
-	@rm -rf "$(BUILDDIR)"/release
-
-clean_custom:
-	@rm -rf "$(BUILDDIR)"/custom
-
-clean: clean_devel clean_release clean_custom clean_source
-	@rm -rf $(BUILDDIR)
-	@echo Removed all doc build artifacts.
-
-setup_devel: clean_devel
-	@./gen_conf.py devel "$(DEVEL_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
-
-setup_release: clean_release
-	@./gen_conf.py release "$(RELEASE_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
-
-setup_custom: clean_custom
-	@./gen_conf.py custom "$(CUSTOM_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
-
-setup_redo: clean_custom
-	@echo Redoing custom build with a possibly reeditted conf.py
-	@./gen_conf.py redo "" "" ""
-
-# Build development labeled html docs.
-devel: Makefile setup_devel
-	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
-
-# Build release labeled html docs.
-release: Makefile setup_release
-	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
-
-# Build custom labeled html docs.
-custom: Makefile setup_custom
-	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
-
-# Build HTML docs with previous generated (possibly hand edited) source/conf.py,
-# put results in $(BUILDDIR)/custom.
-redo: Makefile setup_redo
-	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
-
-# Catch-all target: route all unknown targets to Sphinx and save to $(BUILDDIR)/custom.
-# Reuse a previously generated source/conf.py.
-%: Makefile setup_redo
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
-
-.PHONY: help Makefile
-.PHONY: setup_devel setup_release setup_custom
-.PHONY: devel release
-.PHONY: clean_source clean_devel clean_release clean_custom clean

pythonic_fp_gadgets-4.1.0/docs/gen_conf.py

@@ -1,110 +0,0 @@
-#!/usr/bin/env python
-# Generate conf.py Sphinx configuration executable
-
-import sys
-import os
-
-project_prefix = 'Pythonic FP'
-pypi_prefix = 'pythonic-fp'
-author = 'Geoffrey R. Scheller'
-copyright = f'2023-2026, {author}'
-
-args = sys.argv[1:]
-num_args = len(args)
-
-if num_args == 4:
-    build_type, version, project_name, pypi_name = args
-    project = project_prefix + ' - ' + project_name
-    pypi_project_repo = pypi_prefix + '-' + pypi_name
-    project_url_rst = f'`{project} <https://pypi.org/project/{pypi_project_repo}/>`_'
-    homepage_url_rst = f'`{project_prefix} <https://grscheller.github.io/{pypi_prefix}/>`_'
-
-else:
-    sys.exit('Error: gen_conf.py takes exactly 4 arguments')
-
-match build_type:
-    case 'custom':
-        release = f'{version}'
-        release_string = f'**Custom PyPI Non-release version {release}**'
-    case 'devel':
-        release = f'{version}'
-        release_string = f'**Proposed PyPI release version {release}**'
-    case 'release':
-        release = f'{version}'
-        release_string = f'**PyPI release version {release}**'
-    case 'redo':
-        if not os.path.isfile('source/conf.py'):
-            sys.exit('Error: cannot redo without source/conf.py')
-        sys.exit()
-    case _:
-        sys.exit(f'Error: unknown built_type {build_type} given')
-
-print(f'''# Generated conf.py Sphinx configuration executable
-
-from typing import Any
-from sphinx.application import Sphinx
-
-project = '{project}'
-author = '{author}'
-copyright = '{copyright}'
-release = '{release}'
-release_string = '{release_string}'
-
-def skip_abc_methods(
-    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
-) -> bool:
-    if name in [
-        '__init_subclass__',
-        '__subclasshook__',
-        '__class_getitem__',
-        '__weakref__',
-    ]:
-        return True  # Skip these members
-    return skip
-
-
-def setup(app: Sphinx) -> None:
-    app.connect('autodoc-skip-member', skip_abc_methods)
-
-
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.graphviz',
-]
-
-autodoc_default_options = {{
-    'members': True,
-    'private-members': True,
-    'special-members': True,
-    'inherited-members': False,
-    'show-inheritance': True,
-}}
-autodoc_member_order = 'bysource'
-autoclass_content = 'class'
-autodoc_class_signature = 'separated'
-autodoc_typehints_format = 'short'
-autodoc_use_type_comments = True
-autodoc_docstring_signature = False
-autodoc_preserve_defaults = True
-autodoc_warningiserror = False
-
-templates_path = ['_templates']
-exclude_patterns: list[str] = []
-
-html_theme_options = {{
-    'light_css_variables': {{
-        'color-link--visited': 'var(--color-link)',
-    }},
-    'dark_css_variables': {{
-        'color-link--visited': 'var(--color-link)',
-    }},
-}}
-html_theme = 'furo'
-html_static_path = ['_static']
-html_css_files = ['custom.css']
-
-rst_epilog = """
-.. |RELEASE_STRING| replace:: {release_string}
-
-"""
-''')

pythonic_fp_gadgets-4.1.0/docs/requirements.txt

@@ -1,2 +0,0 @@
-sphinx>=9.1
-furo

pythonic_fp_gadgets-4.1.0/docs/source/_static/custom.css

@@ -1,3 +0,0 @@
-dl.field-list > dt {
-    text-transform: none !important;
-}

pythonic_fp_gadgets-4.1.0/docs/source/api/box.rst

@@ -1,6 +0,0 @@
-box
-===
-
-.. automodule:: pythonic_fp.gadgets.box
-    :members:
-    :special-members:

pythonic_fp_gadgets-4.1.0/docs/source/api/functions/first_common_ancestor.rst

@@ -1,4 +0,0 @@
-First common ancestor
----------------------
-
-.. autofunction:: pythonic_fp.gadgets.first_common_ancestor

pythonic_fp_gadgets-4.1.0/docs/source/api/functions/index.rst

@@ -1,8 +0,0 @@
-functions
-=========
-
-.. toctree::
-    :caption: Functions
-
-    first_common_ancestor
-    iterate_over_arguments

pythonic_fp_gadgets-4.1.0/docs/source/api/functions/iterate_over_arguments.rst

@@ -1,4 +0,0 @@
-Iterate over arguments
-----------------------
-
-.. autofunction:: pythonic_fp.gadgets.iterate_over_arguments

pythonic_fp_gadgets-4.1.0/docs/source/api/index.rst

@@ -1,31 +0,0 @@
-Gadgets
-=======
-
-.. automodule:: pythonic_fp.gadgets
-    :no-members:
-    :ignore-module-all:
-    :no-index:
-
-.. toctree::
-    :caption: functions
-    :maxdepth: 1
-
-    functions/index
-
-.. toctree::
-    :caption: module box
-    :maxdepth: 1
-
-    box
-
-.. toctree::
-    :caption: module wrap
-    :maxdepth: 1
-
-    wrap
-
-.. toctree::
-    :caption: module sentinels
-    :maxdepth: 1
-
-    sentinels/index

pythonic_fp_gadgets-4.1.0/docs/source/api/sentinels/flavored.rst

@@ -1,8 +0,0 @@
-flavored
-========
-
-**Sentinel values "indexed" by hashable values of a given type.**
-
-.. automodule:: pythonic_fp.gadgets.sentinels.flavored
-    :members:
-    :special-members: