pythonic-fp.iterables 5.1.3__tar.gz → 5.1.4__tar.gz

pythonic_fp_iterables-5.1.4/.github/workflows/static.yml

@@ -0,0 +1,64 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  RELEASE: '5.1.4'
+  DEVEL: '5.1.5'
+  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: '3.14'
+
+      - 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-iterables
+          docs/gen_conf.py release ${{ env.RELEASE }} Iterables iterables > 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 }} Iterables iterables > 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_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/.gitignore

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

{pythonic_fp_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/CHANGELOG.rst

@@ -17,6 +17,12 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+Development Status Reappraisal - 2026-05-05
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Maintainer appraised the Development Status for
+pythonic-fp-iterables to be ``"5 - Production/Stable"``.
+
 PyPI 5.1.1 - 2025-08-02
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-iterables
-Version: 5.1.3
-Summary: Tools for iterables
+Version: 5.1.4
+Summary: .. admonition:: Composing and iterating iterables
 Keywords: iterables,iterators
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
@@ -11,15 +11,15 @@ Classifier: Framework :: Pytest
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 License-File: LICENSE
 Requires-Dist: pythonic-fp-fptools>=5.2.0
 Requires-Dist: pythonic-fp-gadgets>=4.0.2
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/iterables/development/build/html/
-Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/projects/iterables.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-iterables
 Provides-Extra: test
 
@@ -27,7 +27,8 @@ Pythonic FP - Tools for iterables
 =================================
 
 PyPI project
-`pythonic-fp.iterators <https://pypi.org/project/pythonic-fp.iterables>`_.
+`pythonic-fp-iterators
+<https://pypi.org/project/pythonic-fp-iterables>`_.
 
 Library of functions for iterating iterables.
 
@@ -44,19 +45,19 @@ Library of functions for iterating iterables.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables>`_.
+<https://grscheller.github.io/pythonic-fp/projects/iterables.html>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

{pythonic_fp_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/README.rst

@@ -2,7 +2,8 @@ Pythonic FP - Tools for iterables
 =================================
 
 PyPI project
-`pythonic-fp.iterators <https://pypi.org/project/pythonic-fp.iterables>`_.
+`pythonic-fp-iterators
+<https://pypi.org/project/pythonic-fp-iterables>`_.
 
 Library of functions for iterating iterables.
 
@@ -19,18 +20,18 @@ Library of functions for iterating iterables.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/iterables>`_.
+<https://grscheller.github.io/pythonic-fp/projects/iterables.html>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_iterables-5.1.4/docs/Makefile

@@ -0,0 +1,78 @@
+# Makefile for Sphinx documentation
+
+# Last and future releases
+#  - former needs to agree with PyPI
+#  - later needs to agree with pyproject.toml
+PROJECT_NAME = Iterables
+PYPI_NAME = iterables
+RELEASE_VERSION = 5.1.4
+DEVEL_VERSION = 5.1.5
+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_iterables-5.1.4/docs/gen_conf.py

@@ -0,0 +1,110 @@
+#!/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_iterables-5.1.4/docs/requirements.txt

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

pythonic_fp_iterables-5.1.4/docs/source/_static/custom.css

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

pythonic_fp_iterables-5.1.4/docs/source/api/drop_take.rst

@@ -0,0 +1,6 @@
+drop_take
+=========
+
+.. automodule:: pythonic_fp.iterables.drop_take
+    :members:
+    :special-members:

pythonic_fp_iterables-5.1.4/docs/source/api/folding.rst

@@ -0,0 +1,6 @@
+folding
+=======
+
+.. automodule:: pythonic_fp.iterables.folding
+    :members:
+    :special-members:

pythonic_fp_iterables-5.1.4/docs/source/api/index.rst

@@ -0,0 +1,25 @@
+Iterables
+=========
+
+.. automodule:: pythonic_fp.iterables
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+
+.. toctree::
+    :caption: Dropping and Taking
+    :maxdepth: 1
+
+    drop_take
+
+.. toctree::
+    :caption: Merging Iterables
+    :maxdepth: 1
+
+    merging
+
+.. toctree::
+    :caption: Folding (Reducing)
+    :maxdepth: 1
+
+    folding

pythonic_fp_iterables-5.1.4/docs/source/api/merging.rst

@@ -0,0 +1,6 @@
+merging
+=======
+
+.. automodule:: pythonic_fp.iterables.merging
+    :members:
+    :special-members:

pythonic_fp_iterables-5.1.4/docs/source/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+---------
+
+Change log for the
+`pythonic-fp-iterables
+<https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst>`_
+PyPI project.

pythonic_fp_iterables-5.1.4/docs/source/description.rst

@@ -0,0 +1,7 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.iterables
+    :synopsis:
+    :noindex:
+

pythonic_fp_iterables-5.1.4/docs/source/index.rst

@@ -0,0 +1,30 @@
+pythonic-fp-iterables
+=====================
+
+Project
+`Pythonic FP - Iterables <https://pypi.org/project/pythonic-fp-iterables/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+|RELEASE_STRING|
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    api/index

pythonic_fp_iterables-5.1.4/docs/source/releases.rst

@@ -0,0 +1,26 @@
+PyPI releases
+=============
+
+**pythonic-fp-iterables:** pythonic_fp.iterables
+
++---------------------------------------------------------------------------------------+--------------+
+| PyPI Release                                                                          | Release date |
++=======================================================================================+==============+
+| `development <https://grscheller.github.io/pythonic-fp-iterables/development/html/>`_ |              |
++---------------------------------------------------------------------------------------+--------------+
+| `v5.1.4 <https://grscheller.github.io/pythonic-fp-iterables/release/html/>`_          | 2026-05-15   |
++---------------------------------------------------------------------------------------+--------------+
+| v5.1.3                                                                                | 2026-01-18   |
++---------------------------------------------------------------------------------------+--------------+
+| v5.1.2                                                                                | 2025-09-26   |
++---------------------------------------------------------------------------------------+--------------+
+| v5.1.1                                                                                | 2025-09-09   |
++---------------------------------------------------------------------------------------+--------------+
+| v5.1.0                                                                                | 2025-09-09   |
++---------------------------------------------------------------------------------------+--------------+
+| v5.0.0                                                                                | 2025-08-02   |
++---------------------------------------------------------------------------------------+--------------+
+| v4.0.0                                                                                | 2025-07-15   |
++---------------------------------------------------------------------------------------+--------------+
+| v3.0.0                                                                                | 2025-07-06   |
++---------------------------------------------------------------------------------------+--------------+

pythonic_fp_iterables-5.1.4/docs/source/usage.rst

@@ -0,0 +1,30 @@
+Usage
+=====
+
+How to install the package
+--------------------------
+
+Install the project into your Python environment:
+
+.. code:: console
+
+    $ pip install pythonic-fp.iterables
+
+Importing the package
+---------------------
+
+Import the functions and the enum into your code.
+
+.. code:: python
+
+    from pythonic_fp.iterables.merging import concat, merge, exhaust
+    from pythonic_fp.iterables.merging import MergeEnum, blend
+
+    from pythonic_fp.iterables.drop_take import drop, drop_while
+    from pythonic_fp.iterables.drop_take import take, take_while
+    from pythonic_fp.iterables.drop_take import take_split, take_while_split
+
+    from pythonic_fp.iterables.folding import accumulate
+    from pythonic_fp.iterables.folding import reduce_left
+    from pythonic_fp.iterables.folding import fold_left, maybe_fold_left
+    from pythonic_fp.iterables.folding import sc_reduce_left, sc_reduce_right

{pythonic_fp_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/pyproject.toml

@@ -1,18 +1,26 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [project]
 name = "pythonic-fp-iterables"
-version = "5.1.3"
+version = "5.1.4"
 readme = "README.rst"
 requires-python = ">=3.13"
-license = { file = "LICENSE" }
-authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
-keywords = ["iterables", "iterators"]
+authors = [
+  { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
+keywords = [
+  "iterables",
+  "iterators",
+]
 classifiers = [
   "Development Status :: 5 - Production/Stable",
   "Framework :: Pytest",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: Apache Software License",
   "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Typing :: Typed",
 ]
 dependencies = [
@@ -23,8 +31,8 @@ dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-iterables/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/iterables/development/build/html/"
-Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
+Documentation = "https://grscheller.github.io/pythonic-fp/projects/iterables.html"
+Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-iterables"
 
 [project.optional-dependencies]
@@ -32,17 +40,11 @@ test = [
   "pytest>=8.4.1",
 ]
 
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
 [tool.flit.module]
 name = "pythonic_fp.iterables"
 
 [tool.mypy]
-enable_incomplete_feature = "NewGenericSyntax"
 explicit_package_bases = true
-implicit_reexport = false
 local_partial_types = true
 namespace_packages = true
 warn_redundant_casts = true
@@ -56,19 +58,24 @@ dmypy = false
 strict = true
 report_progress = true
 
-[tool.pytest.ini_options]
-addopts = "-ra"
+[tool.pytest]
+addopts = [
+  "-ra",
+]
 consider_namespace_packages = true
 testpaths = ["tests/"]
 
 [tool.ruff]
-target-version = "py313"
+target-version = "py314"
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["C901"]
+"tests/**/*.py" = [
+  "E731",
+  "C901",
+]
 "**/*.py" = ["E741"]
 
 [tool.ruff.format]

{pythonic_fp_iterables-5.1.3 → pythonic_fp_iterables-5.1.4}/src/pythonic_fp/iterables/__init__.py

@@ -13,20 +13,11 @@
 # limitations under the License.
 
 """
-Tools for iterables
--------------------
+.. admonition:: Composing and iterating iterables
 
-.. admonition:: Library of functions for iterating iterables
-
-    +-----------+-------------------------------------------+
-    | Module    | Description                               |
-    +===========+===========================================+
-    | merging   | Concatenating and merging iterables       |
-    +-----------+-------------------------------------------+
-    | drop_take | Dropping and taking values from iterables |
-    +-----------+-------------------------------------------+
-    | folding   | Reducing and accumulating iterables       |
-    +-----------+-------------------------------------------+
+    - module **merging:** Concatenating and merging iterables.
+    - module **drop_take:** Dropping and taking values from iterables.
+    - module **folding:**  Reducing and accumulating iterables.
 
 .. important::
 
@@ -35,8 +26,8 @@ Tools for iterables
     - iterables are not necessarily iterators
     - at all times iterator protocol is assumed to be followed
 
-    - all iterators are assumed to be iterable
-    - for all iterators ``foobar`` we assume ``iter(foobar) is foobar``
+      - all iterators are assumed to be iterable
+      - for all iterators ``foobar`` we assume ``iter(foobar) is foobar``
 
 """