pythonic-fp-circulararray 6.0.0__tar.gz → 6.0.2__tar.gz

{pythonic_fp_circulararray-6.0.0 → pythonic_fp_circulararray-6.0.2}/CHANGELOG.rst

@@ -17,7 +17,13 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-PyPI 6.0.0 - 2025-09-25
+PyPI 6.0.1 - 2026-01-08
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements based on lessons learned from my PyPI
+boring-math-abstract-algebra project.
+
+PyPI 6.0.0 - 2025-09-26
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Changed how "optional" iterator in initializer signature is handled.

{pythonic_fp_circulararray-6.0.0 → pythonic_fp_circulararray-6.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-circulararray
-Version: 6.0.0
+Version: 6.0.2
 Summary: Circular Array
 Keywords: auto resizing,circular array,circulararray,dequeue,indexable,pop,push
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -11,14 +11,14 @@ 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-gadgets>=3.1.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-circulararray/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/index.html
-Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-circulararray
 Provides-Extra: test
 
@@ -54,7 +54,7 @@ Python module implementing stateful circular array data structures.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
 Documentation
@@ -62,7 +62,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/circulararray>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_circulararray-6.0.0 → pythonic_fp_circulararray-6.0.2}/README.rst

@@ -30,7 +30,7 @@ Python module implementing stateful circular array data structures.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
 Documentation
@@ -38,7 +38,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/circulararray/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/circulararray>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_circulararray-6.0.0 → pythonic_fp_circulararray-6.0.2}/pyproject.toml

@@ -1,9 +1,12 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [project]
 name = "pythonic-fp-circulararray"
-version = "6.0.0"
+version = "6.0.2"
 readme = "README.rst"
 requires-python = ">=3.13"
-license = { file = "LICENSE" }
 authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
 keywords = [
   "auto resizing",
@@ -20,18 +23,18 @@ classifiers = [
   "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 = [
-  "pythonic-fp-gadgets>=3.1.0",
+  "pythonic-fp-gadgets>=4.0.2",
 ]
 dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-circulararray/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/index.html"
-Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Documentation = "https://grscheller.github.io/pythonic-fp/circulararray/development/build/html/"
+Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
 Source = "https://github.com/grscheller/pythonic-fp-circulararray"
 
 [project.optional-dependencies]
@@ -39,17 +42,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.circulararray"
 
 [tool.mypy]
-enable_incomplete_feature = "NewGenericSyntax"
 explicit_package_bases = true
-implicit_reexport = false
 local_partial_types = true
 namespace_packages = true
 warn_redundant_casts = true
@@ -63,19 +60,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_circulararray-6.0.2/src/pythonic_fp/circulararray/__init__.py

@@ -0,0 +1,35 @@
+# Copyright 2024-2026 Geoffrey R. Scheller
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Circular Array
+--------------
+
+.. admonition:: Stateful circular array data structures.
+
+    - O(1) pops and pushes either end
+    - O(1) size determination
+    - O(1) indexing
+    - Two types of circular arrays, fixed and variable capacity
+
+.. note::
+
+    - Class constructors ``CA`` and ``CAF`` take an optional iterator to populate circular array.
+    - Factory Functions ``ca`` and ``caf`` take a variable number of parameters to populate circular array.
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'