py-geometry-utils 0.5.0__tar.gz

py_geometry_utils-0.5.0/.github/workflows/build-test.yml

@@ -0,0 +1,37 @@
+name: Build project
+
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build & test project on ${{ matrix.os }}, Python ${{ matrix.python-version }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ 'ubuntu-latest', 'windows-latest', 'macos-latest' ]
+        python-version: [ '3.12', '3.13', '3.14' ]
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+        architecture: x64
+    - name: Install project
+      run: |
+        python -m pip install --upgrade pip
+        pip install .
+    - name: Install test dependencies
+      run: pip install .[dev]
+    - name: Test
+      run: |
+        pytest -v --doctest-modules

py_geometry_utils-0.5.0/.github/workflows/publish-to-pypi.yml

@@ -0,0 +1,77 @@
+name: Publish Python distribution to PyPI and TestPyPI
+
+on:
+  push:
+    branches:
+      - 'ci/*'
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build binary wheel and source tarball
+      run: python3 -m build
+    - name: Store distributions
+      uses: actions/upload-artifact@v5
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-testpypi:
+    name: Publish to TestPyPI
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/py-geometry-utils
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        verbose: true
+        repository-url: https://test.pypi.org/legacy/
+
+  publish-to-pypi:
+    name: Publish to production PyPI
+    if: startswith(github.ref, 'refs/tags/')
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/py-geometry-utils
+    permissions:
+      id-token: write
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v6
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish distribution to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

py_geometry_utils-0.5.0/.github/workflows/type-lint.yml

@@ -0,0 +1,36 @@
+name: Lint and type check
+
+on:
+  push:
+    branches: [ "**" ]
+  pull_request:
+    branches: [ "**" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Lint and type check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.12', '3.13', '3.14' ]
+
+    steps:
+    - uses: actions/checkout@v7
+    - name: Set up Python
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+        architecture: x64
+    - name: Install project + dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install .[dev]
+    - name: Check with ty
+      run: |
+        ty check .
+    - name: Lint with ruff
+      run: |
+        ruff check .

py_geometry_utils-0.5.0/.gitignore

@@ -0,0 +1,17 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+_build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv/
+
+# Cache dirs
+.*cache*/
+
+/_*
+_html/

py_geometry_utils-0.5.0/.python-version

@@ -0,0 +1 @@
+3.12

py_geometry_utils-0.5.0/.readthedocs.yaml

@@ -0,0 +1,23 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

py_geometry_utils-0.5.0/CHANGELOG.md

@@ -0,0 +1,114 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+This project uses [towncrier](https://towncrier.readthedocs.io) to generate release notes.
+
+<!-- towncrier release notes start -->
+
+## [0.5.0] - 2026-08-02
+
+### Added
+
+- Added method `Coord2._compare()` to handle all comparisons except `==`
+- Added method `Coord2.zip_with()`
+- Added method `Grid2.zip_with()
+- Added method `Rect.zip_with()
+- Added support for `# testcheck: ignore` comments on class definitions
+- Added type alias `Tuple2`
+- Added type alias `Tuple4`
+
+### Changed
+
+- Initializing `Grid2` with an out-of-bounds `origin` value no longer raises an
+  error (#7)
+  - "steps" methods will yield no steps when `Grid2.origin` is out of bounds
+- Attribute `tests.check.FunctionFinder.functions` now uses `ast.ClassDef`
+  nodes for keys instead of class name strings
+- Rename `tests.check.FUNC_IGNORE_REGEX` to `IGNORE_REGEX`
+- Renamed parameter `value` to `other` in `Coord2` methods `__eq__`, `__ge__`,
+  `__gt__`, `__le__`, and `__lt__` for consistency with other methods
+- `Coord2` comparison methods `__ge__`, `__gt__`, `__le__`, and `__lt__` all
+  now `Coord2._compare()` instead of implementing the logic in themselves
+- `Coord2` objects are now always truthy, removed `__bool__` implementation
+- `tests.check.make_test_name()` now adds a prefix for private (and not magic)
+  methods
+
+### Removed
+
+- Removed method `Coord2.binop()`
+- Removed type alias `BinaryOp`
+
+## [0.4.0] - 2026-07-30
+
+### Added
+
+- Added property `Coord2.mutable` (#6)
+- Added property `Rect.mutable` (#6)
+- Added property `Grid2.mutable` (#6)
+- Added optional parameter `mut` to `Coord2.__init__()` (#6)
+- Added optional parameter `mut` to `Rect.__init__()` (#6)
+- Added optional parameter `mut` to `Grid2.__init__()` (#6)
+- Added override method `Grid2.from_size()`
+  - Allows setting the `step` and `origin` of the resulting instance
+- Added function `util.partition()` (#6)
+
+### Changed
+
+- `Coord2`, `Rect`, and `Grid2` are now "immutable" by default, and must be
+  initialized with `mut=True` to modify their attributes
+- `Coord2` attributes `x` and `y` are now properties
+  - Values can only be set if `Coord2` was initialized with `mut=True` (#6)
+- `Rect` attributes `x1`, `y1`, `x2`, and `y2` are now properties
+  - Values can only be set if `Rect` was initialized with `mut=True` (#6)
+- `Grid2` attributes `step` and `origin` are now properties
+  - Values can only be set if `Grid2` was initialized with `mut=True` (#6)
+- `Grid2.step` and `Grid2.origin` are now properties, value is automatically
+  coerced to `Coord2` when setting
+
+## [0.3.0]
+
+### Added
+
+- Added parameter `inf` to method `Grid2.steps_x()`
+- Added parameter `inf` to method `Grid2.steps_y()`
+- Added method `Coord2.snap_to_grid()`
+- Implemented `__copy__` for `Coord2` (#1)
+- Implemented `__str__` for `Coord2`
+- Implemented `__copy__` for `Rect` (#1)
+- Implemented `__copy__` for `Grid2` (#1)
+- Implemented `__deepcopy__` for `Grid2` (#1)
+- Added function `util.take_n()`
+
+### Changed
+
+- `Grid2` is now a subclass of `Rect`
+- `Grid2.__str__()` now includes step and origin values instead of just the rectangle coordiantes
+- `Grid2.steps()` now yields coordinates even if the X or Y of the step value is 0, in which case
+  the corresponding value of the grid's origin coordinate is used for that value of the yielded
+  coordinates
+- `util.snap_num()` parameter `mult` is now typed as `float`
+- `util.snap_num()` return type is now `float`
+- `util.snap_num()` parameter `snap_fn` is now optional (defaults to the built-in `round` function)
+
+## [0.2.0] - 2026-07-22
+
+### Added
+
+- Added method `Coord2.distance()`
+  - Calculates euclidean or taxicab distance between two coordinates depending on the `mode` parameter
+- Added method `Grid2.project()`
+  - Returns a coordinate in the same relative position to the `other` grid as it was to `self`
+  - Can be useful for plotting points from a grid with a negative x1 or y1 value onto an image which
+    requires using a grid whose top-left is 0, 0
+- Added property `Rect.bottom_left`
+- Added property `Rect.bottom_right`
+- Added property `Rect.top_left`
+- Added property `Rect.top_right`
+
+## [0.1.0] - 2026-07-21
+
+Initial beta release.

py_geometry_utils-0.5.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Seth "Violet" Gibbs
+
+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.

py_geometry_utils-0.5.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.4
+Name: py-geometry-utils
+Version: 0.5.0
+Summary: Utilities for working with coordinates and rectangles/grids.
+Project-URL: Homepage, https://github.com/svioletg/py-geometry-utils
+Project-URL: Repository, https://github.com/svioletg/py-geometry-utils
+Project-URL: Documentation, https://py-geometry-utils.readthedocs.io/en/latest/
+Project-URL: Changelog, https://github.com/svioletg/py-geometry-utils/blob/main/CHANGELOG.md
+Project-URL: Issues, https://github.com/svioletg/py-geometry-utils/issues
+Author: Seth 'Violet' Gibbs
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.12
+Provides-Extra: dev
+Requires-Dist: py-maybetype>=0.14.0; extra == 'dev'
+Requires-Dist: pytest>=9.1.1; extra == 'dev'
+Requires-Dist: ruff>=0.15.22; extra == 'dev'
+Requires-Dist: towncrier>=25.8.0; extra == 'dev'
+Requires-Dist: ty>=0.0.61; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2025.12.19; extra == 'docs'
+Requires-Dist: myst-parser>=5.1.0; extra == 'docs'
+Requires-Dist: sphinx-autobuild>=2025.8.25; extra == 'docs'
+Requires-Dist: sphinx>=9.1; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# py-geometry-utils
+
+Provides utilities for working with coordinates, rectangles, and grids.
+
+Initially [part of a different project](https://github.com/svioletg/py-squaremap-combiner/blob/47f30bffb5de121fbf5ce17621ce3b8127cd36c3/src/squaremap_combine/geo.py),
+I wanted to use it in a few other projects so I decided to separate it out into its own package.
+
+Documentation: <https://py-geometry-utils.readthedocs.io/en/latest/>
+
+Changelog: <https://github.com/svioletg/py-geometry-utils/blob/main/CHANGELOG.md>

py_geometry_utils-0.5.0/README.md

@@ -0,0 +1,10 @@
+# py-geometry-utils
+
+Provides utilities for working with coordinates, rectangles, and grids.
+
+Initially [part of a different project](https://github.com/svioletg/py-squaremap-combiner/blob/47f30bffb5de121fbf5ce17621ce3b8127cd36c3/src/squaremap_combine/geo.py),
+I wanted to use it in a few other projects so I decided to separate it out into its own package.
+
+Documentation: <https://py-geometry-utils.readthedocs.io/en/latest/>
+
+Changelog: <https://github.com/svioletg/py-geometry-utils/blob/main/CHANGELOG.md>

py_geometry_utils-0.5.0/changes/.gitignore

@@ -0,0 +1 @@
+!.gitignore

py_geometry_utils-0.5.0/docs/changelog.rst

@@ -0,0 +1,5 @@
+Changelog
+===========
+
+.. include:: ../CHANGELOG.md
+    :parser: myst_parser.sphinx_

py_geometry_utils-0.5.0/docs/conf.py

@@ -0,0 +1,39 @@
+from geometry import __version__  # noqa: D100, INP001
+
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'py-geometry-utils'
+author = "Seth 'Violet' Gibbs"
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'myst_parser',
+]
+
+autodoc_member_order = 'bysource'
+autodoc_default_options = {
+    'exclude-members': '__weakref__',
+}
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'furo'
+html_static_path = ['_static']
+
+rst_prolog = f"""
+.. |project| replace:: {project}
+"""

py_geometry_utils-0.5.0/docs/index.rst

@@ -0,0 +1,17 @@
+|project| documentation
+===============================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   readme.rst
+   changelog.rst
+   reference/index.rst
+   reference/util.rst
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`

py_geometry_utils-0.5.0/docs/readme.rst

@@ -0,0 +1,5 @@
+README
+===========
+
+.. include:: ../README.md
+    :parser: myst_parser.sphinx_

py_geometry_utils-0.5.0/docs/reference/index.rst

@@ -0,0 +1,9 @@
+.. py:module:: geometry
+.. py:currentmodule:: geometry
+
+:py:mod:`~geometry` module
+========================================
+
+.. automodule:: geometry
+   :members:
+   :special-members:

py_geometry_utils-0.5.0/docs/reference/util.rst

@@ -0,0 +1,9 @@
+.. py:module:: geometry.util
+.. py:currentmodule:: geometry.util
+
+:py:mod:`~geometry.util` module
+========================================
+
+.. automodule:: geometry.util
+   :members:
+   :special-members: