sqlalchemy-postgres-point 0.1.1__tar.gz → 0.2.1__tar.gz

{sqlalchemy_postgres_point-0.1.1 → sqlalchemy_postgres_point-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: sqlalchemy-postgres-point
-Version: 0.1.1
+Version: 0.2.1
 Summary: Lightweight SQLAlchemy custom type for PostgreSQL POINT columns with tuple binding and an earth-distance comparator.
 Keywords: sqlalchemy,postgresql,point,geometry,geospatial,gis,database,types,earthdistance
 Author: Michael Bianco
@@ -15,18 +15,15 @@ Description-Content-Type: text/markdown
 ![GitHub CI Status](https://github.com/iloveitaly/sqlalchemy-postgres-point/actions/workflows/build_and_publish.yml/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-sqlalchemy-postgres-point
-=========================
+# sqlalchemy-postgres-point
 
 Lightweight, pure-Python SQLAlchemy custom type for PostgreSQL `POINT` columns.
 
-Why
-----
+## Why
 
 PostgreSQL has a native `POINT` type (stored internally as a pair of float8 values). SQLAlchemy does not ship a dedicated high-level type wrapper for simple geometric primitives. This package provides a very small `PointType` you can use immediately without pulling in a full spatial stack (e.g. PostGIS + GeoAlchemy2) when all you need is storing and retrieving `(longitude, latitude)` pairs.
 
-Features
---------
+## Features
 
 * Simple `(lng, lat)` tuple binding and result conversion.
 * Safe NULL handling.
@@ -34,23 +31,13 @@ Features
 * Custom comparator exposing the PostgreSQL earth-distance `<@>` operator (returns a `Float`).
 * `cache_ok = True` for SQLAlchemy 2.x compilation caching.
 
-Installation
-------------
-
-Using `uv` (recommended):
+## Installation
 
 ```bash
 uv add sqlalchemy-postgres-point
 ```
 
-Or with pip:
-
-```bash
-pip install sqlalchemy-postgres-point
-```
-
-Usage
------
+## Usage
 
 ```python
 from sqlalchemy import Column, Integer
@@ -119,54 +106,55 @@ DROP EXTENSION IF EXISTS cube;
 """)
 ```
 
-**Integration Steps:**
+#### Integration Steps
 
 1. Generate a new migration: `alembic revision -m "add_postgres_extensions"`
 2. Copy the `upgrade()` and `downgrade()` functions above into your new migration file
 3. Run the migration: `alembic upgrade head`
 
-Returned Python Values
-----------------------
+## Returned Python Values
 
 Values are loaded as a 2-tuple of floats `(lng, lat)` or `None` when NULL.
 
-Testing
--------
+## Alembic Integration
 
-Run the test suite with:
+To ensure generated migration files include the correct `PointType` import, pass the provided `render_item` hook to `context.configure()` in your `alembic/env.py`:
 
-```bash
-uv run pytest -q
+```python
+from sqlalchemy_postgres_point.alembic_integration import render_item
+
+# in run_migrations_online and run_migrations_offline:
+context.configure(
+    # ... other options ...
+    render_item=render_item,
+)
 ```
 
-Development
------------
+Once wired up, `from sqlalchemy_postgres_point import PointType` will be automatically included in generated migration files whenever a `PointType` column is detected.
 
-After cloning:
+### Chaining `render_item`
 
-```bash
-uv sync  # installs runtime + dev deps
-uv run pytest -q
-```
+It's insane to me, but you have to chain multiple `render_item` instances you may have yourself.
 
-Project Structure
------------------
+```python
+from sqlalchemy_postgres_point.alembic_integration import render_item as render_point
+
+def render_item(type_, obj, autogen_context):
+    return (
+        render_point(type_, obj, autogen_context)
+        or other_package.render_item(type_, obj, autogen_context)
+        or False
+    )
+```
 
-* `sqlalchemy_postgres_point/point.py` – Implementation of `PointType`.
-* `tests/test_point.py` – Unit tests for processors and comparator.
+Or you could use something like [`some_fn`](https://funcy.readthedocs.io/en/stable/funcs.html#some_fn) to make this even cleaner.
 
-Limitations / Notes
--------------------
+## Limitations / Notes
 
-* No automatic validation of longitude/latitude ranges; add your own if required.
+* Coordinates are validated on both write and read: longitude must be within `[-180, 180]`, latitude within `[-90, 90]`, and non-finite values (`NaN`, `inf`) are rejected with a `ValueError`.
 * Uses simple textual representation `(lng,lat)` accepted by PostgreSQL `POINT` input parser.
 * If you need advanced spatial indexing / SRID support, look at GeoAlchemy2/PostGIS instead.
 
-License
--------
-
-MIT (see your project's LICENSE file if added later). Contributions welcome.
-
 ---
 
 *This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*

{sqlalchemy_postgres_point-0.1.1 → sqlalchemy_postgres_point-0.2.1}/README.md

@@ -3,18 +3,15 @@
 ![GitHub CI Status](https://github.com/iloveitaly/sqlalchemy-postgres-point/actions/workflows/build_and_publish.yml/badge.svg)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-sqlalchemy-postgres-point
-=========================
+# sqlalchemy-postgres-point
 
 Lightweight, pure-Python SQLAlchemy custom type for PostgreSQL `POINT` columns.
 
-Why
-----
+## Why
 
 PostgreSQL has a native `POINT` type (stored internally as a pair of float8 values). SQLAlchemy does not ship a dedicated high-level type wrapper for simple geometric primitives. This package provides a very small `PointType` you can use immediately without pulling in a full spatial stack (e.g. PostGIS + GeoAlchemy2) when all you need is storing and retrieving `(longitude, latitude)` pairs.
 
-Features
---------
+## Features
 
 * Simple `(lng, lat)` tuple binding and result conversion.
 * Safe NULL handling.
@@ -22,23 +19,13 @@ Features
 * Custom comparator exposing the PostgreSQL earth-distance `<@>` operator (returns a `Float`).
 * `cache_ok = True` for SQLAlchemy 2.x compilation caching.
 
-Installation
-------------
-
-Using `uv` (recommended):
+## Installation
 
 ```bash
 uv add sqlalchemy-postgres-point
 ```
 
-Or with pip:
-
-```bash
-pip install sqlalchemy-postgres-point
-```
-
-Usage
------
+## Usage
 
 ```python
 from sqlalchemy import Column, Integer
@@ -107,54 +94,55 @@ DROP EXTENSION IF EXISTS cube;
 """)
 ```
 
-**Integration Steps:**
+#### Integration Steps
 
 1. Generate a new migration: `alembic revision -m "add_postgres_extensions"`
 2. Copy the `upgrade()` and `downgrade()` functions above into your new migration file
 3. Run the migration: `alembic upgrade head`
 
-Returned Python Values
-----------------------
+## Returned Python Values
 
 Values are loaded as a 2-tuple of floats `(lng, lat)` or `None` when NULL.
 
-Testing
--------
+## Alembic Integration
 
-Run the test suite with:
+To ensure generated migration files include the correct `PointType` import, pass the provided `render_item` hook to `context.configure()` in your `alembic/env.py`:
 
-```bash
-uv run pytest -q
+```python
+from sqlalchemy_postgres_point.alembic_integration import render_item
+
+# in run_migrations_online and run_migrations_offline:
+context.configure(
+    # ... other options ...
+    render_item=render_item,
+)
 ```
 
-Development
------------
+Once wired up, `from sqlalchemy_postgres_point import PointType` will be automatically included in generated migration files whenever a `PointType` column is detected.
 
-After cloning:
+### Chaining `render_item`
 
-```bash
-uv sync  # installs runtime + dev deps
-uv run pytest -q
-```
+It's insane to me, but you have to chain multiple `render_item` instances you may have yourself.
 
-Project Structure
------------------
+```python
+from sqlalchemy_postgres_point.alembic_integration import render_item as render_point
+
+def render_item(type_, obj, autogen_context):
+    return (
+        render_point(type_, obj, autogen_context)
+        or other_package.render_item(type_, obj, autogen_context)
+        or False
+    )
+```
 
-* `sqlalchemy_postgres_point/point.py` – Implementation of `PointType`.
-* `tests/test_point.py` – Unit tests for processors and comparator.
+Or you could use something like [`some_fn`](https://funcy.readthedocs.io/en/stable/funcs.html#some_fn) to make this even cleaner.
 
-Limitations / Notes
--------------------
+## Limitations / Notes
 
-* No automatic validation of longitude/latitude ranges; add your own if required.
+* Coordinates are validated on both write and read: longitude must be within `[-180, 180]`, latitude within `[-90, 90]`, and non-finite values (`NaN`, `inf`) are rejected with a `ValueError`.
 * Uses simple textual representation `(lng,lat)` accepted by PostgreSQL `POINT` input parser.
 * If you need advanced spatial indexing / SRID support, look at GeoAlchemy2/PostGIS instead.
 
-License
--------
-
-MIT (see your project's LICENSE file if added later). Contributions welcome.
-
 ---
 
 *This project was created from [iloveitaly/python-package-template](https://github.com/iloveitaly/python-package-template)*

{sqlalchemy_postgres_point-0.1.1 → sqlalchemy_postgres_point-0.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlalchemy-postgres-point"
-version = "0.1.1"
+version = "0.2.1"
 description = "Lightweight SQLAlchemy custom type for PostgreSQL POINT columns with tuple binding and an earth-distance comparator."
 keywords = [
     "sqlalchemy",
@@ -21,7 +21,7 @@ urls = { "Repository" = "https://github.com/iloveitaly/sqlalchemy-postgres-point
 
 
 [build-system]
-requires = ["uv_build>=0.10.0"]
+requires = ["uv_build>=0.11.0,<0.12"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]
@@ -39,6 +39,7 @@ dev = [
     "coverage>=7.13.4",
     "pytest-cov>=7.0.0",
     "covdefaults>=2.3.0",
+    "alembic>=1.16.5",
 ]
 
 [tool.pyright]

sqlalchemy_postgres_point-0.2.1/sqlalchemy_postgres_point/alembic_integration.py

@@ -0,0 +1,32 @@
+"""
+Alembic integration for rendering PointType in generated migration files.
+
+Usage — add two lines to your alembic/env.py:
+
+    from sqlalchemy_postgres_point.alembic_integration import render_item
+
+Then pass it to both context.configure() calls:
+
+    context.configure(
+        ...,
+        render_item=render_item,
+    )
+
+Once wired up, ``from sqlalchemy_postgres_point import PointType`` will be
+automatically included in generated migration files whenever PointType is used.
+"""
+
+from .point import PointType
+
+
+def render_item(type_, obj, autogen_context):
+    """Alembic render_item hook that handles PointType columns.
+
+    Returns "PointType()" and registers the import when the rendered item is a
+    PointType instance. Returns False for everything else so Alembic falls back
+    to its default rendering.
+    """
+    if type_ == "type" and isinstance(obj, PointType):
+        autogen_context.imports.add("from sqlalchemy_postgres_point import PointType")
+        return "PointType()"
+    return False