rangeslib 0.6.0__tar.gz

rangeslib-0.6.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aaryan Banerjee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

rangeslib-0.6.0/MANIFEST.in

@@ -0,0 +1,7 @@
+include LICENSE
+include README.md
+include requirements.txt
+include playground.py
+recursive-include scripts *.py *.sh
+recursive-include docs *.md *.rst *.py
+recursive-include tests *.py

rangeslib-0.6.0/PKG-INFO

@@ -0,0 +1,205 @@
+Metadata-Version: 2.4
+Name: rangeslib
+Version: 0.6.0
+Summary: Composable, typed Python ranges and iterable adaptors
+Author: Aaryan Banerjee
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/TheUltimateOrion/RangesLib
+Project-URL: Documentation, https://theultimateorion.github.io/RangesLib/
+Project-URL: Repository, https://github.com/TheUltimateOrion/RangesLib.git
+Project-URL: Issues, https://github.com/TheUltimateOrion/RangesLib/issues
+Keywords: ranges,iterables,pipelines,functional,typing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: docs
+Requires-Dist: myst-parser>=4; extra == "docs"
+Requires-Dist: sphinx>=8; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints>=3; extra == "docs"
+Provides-Extra: test
+Requires-Dist: coverage[toml]>=7.6; extra == "test"
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: coverage[toml]>=7.6; extra == "dev"
+Requires-Dist: mypy>=1.15; extra == "dev"
+Requires-Dist: myst-parser>=4; extra == "dev"
+Requires-Dist: pre-commit>=4.0; extra == "dev"
+Requires-Dist: pyright>=1.1.400; extra == "dev"
+Requires-Dist: ruff>=0.9; extra == "dev"
+Requires-Dist: sphinx>=8; extra == "dev"
+Requires-Dist: sphinx-autodoc-typehints>=3; extra == "dev"
+Dynamic: license-file
+
+# rangeslib
+
+[![Tests and quality](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/tests.yml/badge.svg)](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/tests.yml)
+[![Documentation](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/docs.yml/badge.svg)](https://theultimateorion.github.io/RangesLib/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+`rangeslib` is a typed Python library for eager, C++-inspired range pipelines.
+The public API is intentionally small:
+
+```python
+from rangeslib import ranges, views
+```
+
+The mental model is:
+
+```text
+ranges creates values
+views transforms values
+views.to converts the final result
+```
+
+## Quick Start
+
+```python
+from rangeslib import ranges, views
+
+result = (
+    ranges.iota(1, 11)
+    | views.filter(lambda value: value % 2 == 0)
+    | views.transform(lambda value: value * 10)
+    | views.take(3)
+    | views.to(list)
+)
+
+assert result == [20, 40, 60]
+```
+
+`Range` values are eager and reusable. Most adaptors return another `Range`; the
+terminal `views.to(...)` adaptor returns whatever collection or factory you ask
+for.
+
+## Existing Iterables
+
+Ordinary Python iterables can start pipelines too:
+
+```python
+from rangeslib import views
+
+text = "abcdef" | views.take(3) | views.to("".join)
+assert text == "abc"
+
+chars = "abc" | views.all()
+assert list(chars) == ["a", "b", "c"]
+```
+
+`views.all()` is the eager Python counterpart to C++ `views::all`: it adapts an
+existing iterable into a reusable `Range`.
+
+## Reusable Pipelines
+
+Adaptors can be composed before data is supplied:
+
+```python
+from rangeslib import views
+
+first_three_even = views.filter(lambda value: value % 2 == 0) | views.take(3)
+
+assert list([1, 2, 3, 4, 5, 6] | first_three_even) == [2, 4, 6]
+assert list([10, 11, 12, 14] | first_three_even) == [10, 12, 14]
+```
+
+## Sources And Views
+
+The `ranges` facade creates source ranges:
+
+```python
+from rangeslib import ranges
+
+ranges.empty()
+ranges.single("value")
+ranges.iota(1, 5)
+ranges.indices(3)
+ranges.repeat("x", 3)
+```
+
+The `views` facade contains transformations such as:
+
+```text
+all, reverse, filter, transform, take, drop, counted,
+elements, keys, values, enumerate, concat, zip, cartesian_product,
+adjacent, pairwise, chunk, slide, stride, join, split, to
+```
+
+See [docs/usage.md](docs/usage.md) for the full API catalog.
+
+## C++ Ranges Correspondence
+
+`rangeslib` borrows naming and broad behavior from C++20/23/26 ranges, but it
+is not a lazy C++ view implementation. The most important differences are:
+
+- Python iterables replace C++ iterator/sentinel pairs.
+- `Range` stores eager values instead of reference-like lazy views.
+- Tuple results are ordinary Python tuples, not tuples of references.
+- Python type checking is useful but cannot express every C++ tuple-like rule.
+
+See [docs/cpp-comparison.md](docs/cpp-comparison.md) for details.
+
+## Installation
+
+Python 3.12 or newer is required.
+
+```bash
+python -m pip install .
+```
+
+For development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+`rangeslib` has no runtime dependencies.
+
+## Development
+
+Useful commands live in `scripts/`:
+
+```bash
+./scripts/run_tests.sh       # tests only
+./scripts/typecheck.sh       # mypy + Pyright
+./scripts/check.sh           # Ruff, typing, tests, coverage
+./scripts/check_all.sh       # check.sh + strict Sphinx docs
+./scripts/check_package.sh   # sdist/wheel build and install smoke test
+./scripts/run_playground.sh  # manual playground
+```
+
+Before a release commit, run:
+
+```bash
+./scripts/check_all.sh
+./scripts/check_package.sh
+```
+
+## Documentation
+
+Build the Sphinx site with:
+
+```bash
+./scripts/generate_docs.sh
+```
+
+Generated HTML is written to `docs/_build/html/` and published to GitHub Pages
+after CI succeeds on `main`.
+
+## Releases
+
+Changing `[project].version` in `pyproject.toml` on `main` automatically runs
+the complete quality and package checks, then creates the matching Git tag and
+GitHub Release. Published GitHub Releases trigger PyPI publishing through
+Trusted Publishing after the PyPI project is configured.
+
+For future work, prefer opening or collecting issues before adding more adaptors
+immediately. See [docs/roadmap.md](docs/roadmap.md).
+
+See [docs/publishing.md](docs/publishing.md) for the PyPI setup checklist.

rangeslib-0.6.0/README.md

@@ -0,0 +1,166 @@
+# rangeslib
+
+[![Tests and quality](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/tests.yml/badge.svg)](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/tests.yml)
+[![Documentation](https://github.com/TheUltimateOrion/RangesLib/actions/workflows/docs.yml/badge.svg)](https://theultimateorion.github.io/RangesLib/)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue)](https://www.python.org/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+`rangeslib` is a typed Python library for eager, C++-inspired range pipelines.
+The public API is intentionally small:
+
+```python
+from rangeslib import ranges, views
+```
+
+The mental model is:
+
+```text
+ranges creates values
+views transforms values
+views.to converts the final result
+```
+
+## Quick Start
+
+```python
+from rangeslib import ranges, views
+
+result = (
+    ranges.iota(1, 11)
+    | views.filter(lambda value: value % 2 == 0)
+    | views.transform(lambda value: value * 10)
+    | views.take(3)
+    | views.to(list)
+)
+
+assert result == [20, 40, 60]
+```
+
+`Range` values are eager and reusable. Most adaptors return another `Range`; the
+terminal `views.to(...)` adaptor returns whatever collection or factory you ask
+for.
+
+## Existing Iterables
+
+Ordinary Python iterables can start pipelines too:
+
+```python
+from rangeslib import views
+
+text = "abcdef" | views.take(3) | views.to("".join)
+assert text == "abc"
+
+chars = "abc" | views.all()
+assert list(chars) == ["a", "b", "c"]
+```
+
+`views.all()` is the eager Python counterpart to C++ `views::all`: it adapts an
+existing iterable into a reusable `Range`.
+
+## Reusable Pipelines
+
+Adaptors can be composed before data is supplied:
+
+```python
+from rangeslib import views
+
+first_three_even = views.filter(lambda value: value % 2 == 0) | views.take(3)
+
+assert list([1, 2, 3, 4, 5, 6] | first_three_even) == [2, 4, 6]
+assert list([10, 11, 12, 14] | first_three_even) == [10, 12, 14]
+```
+
+## Sources And Views
+
+The `ranges` facade creates source ranges:
+
+```python
+from rangeslib import ranges
+
+ranges.empty()
+ranges.single("value")
+ranges.iota(1, 5)
+ranges.indices(3)
+ranges.repeat("x", 3)
+```
+
+The `views` facade contains transformations such as:
+
+```text
+all, reverse, filter, transform, take, drop, counted,
+elements, keys, values, enumerate, concat, zip, cartesian_product,
+adjacent, pairwise, chunk, slide, stride, join, split, to
+```
+
+See [docs/usage.md](docs/usage.md) for the full API catalog.
+
+## C++ Ranges Correspondence
+
+`rangeslib` borrows naming and broad behavior from C++20/23/26 ranges, but it
+is not a lazy C++ view implementation. The most important differences are:
+
+- Python iterables replace C++ iterator/sentinel pairs.
+- `Range` stores eager values instead of reference-like lazy views.
+- Tuple results are ordinary Python tuples, not tuples of references.
+- Python type checking is useful but cannot express every C++ tuple-like rule.
+
+See [docs/cpp-comparison.md](docs/cpp-comparison.md) for details.
+
+## Installation
+
+Python 3.12 or newer is required.
+
+```bash
+python -m pip install .
+```
+
+For development:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+`rangeslib` has no runtime dependencies.
+
+## Development
+
+Useful commands live in `scripts/`:
+
+```bash
+./scripts/run_tests.sh       # tests only
+./scripts/typecheck.sh       # mypy + Pyright
+./scripts/check.sh           # Ruff, typing, tests, coverage
+./scripts/check_all.sh       # check.sh + strict Sphinx docs
+./scripts/check_package.sh   # sdist/wheel build and install smoke test
+./scripts/run_playground.sh  # manual playground
+```
+
+Before a release commit, run:
+
+```bash
+./scripts/check_all.sh
+./scripts/check_package.sh
+```
+
+## Documentation
+
+Build the Sphinx site with:
+
+```bash
+./scripts/generate_docs.sh
+```
+
+Generated HTML is written to `docs/_build/html/` and published to GitHub Pages
+after CI succeeds on `main`.
+
+## Releases
+
+Changing `[project].version` in `pyproject.toml` on `main` automatically runs
+the complete quality and package checks, then creates the matching Git tag and
+GitHub Release. Published GitHub Releases trigger PyPI publishing through
+Trusted Publishing after the PyPI project is configured.
+
+For future work, prefer opening or collecting issues before adding more adaptors
+immediately. See [docs/roadmap.md](docs/roadmap.md).
+
+See [docs/publishing.md](docs/publishing.md) for the PyPI setup checklist.

rangeslib-0.6.0/docs/api.rst

@@ -0,0 +1,27 @@
+API reference
+=============
+
+The supported application-facing API consists of :class:`rangeslib.Range`,
+:mod:`rangeslib.ranges`, and :mod:`rangeslib.views`. Modules beginning with an
+underscore are private implementation details.
+
+Core container
+--------------
+
+.. autoclass:: rangeslib.Range
+   :members: copy, is_empty
+   :show-inheritance:
+
+Generator facade
+----------------
+
+.. automodule:: rangeslib.ranges
+   :members:
+   :undoc-members:
+
+View facade
+-----------
+
+.. automodule:: rangeslib.views
+   :members:
+   :undoc-members: