sqlalchemy-postgres-point 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

sqlalchemy_postgres_point/alembic_integration.py

@@ -0,0 +1,56 @@
+"""
+Alembic integration to automatically add imports for PointType in migration files.
+
+This module hooks into Alembic's autogenerate system to automatically include
+the necessary import statement when PointType is detected in models.
+
+Usage:
+    Add this import to your alembic/env.py file:
+
+    import sqlalchemy_postgres_point.alembic_integration
+
+Once added, `from sqlalchemy_postgres_point import PointType` will be automatically
+included in generated migration files.
+"""
+
+import alembic.autogenerate
+import alembic.operations.ops
+from sqlalchemy.types import UserDefinedType
+
+from .point import PointType
+
+
+def render_point_type(type_, object_, autogen_context):
+    """Render PointType in migration files with proper import."""
+    # Add the import to the migration file
+    autogen_context.imports.add("from sqlalchemy_postgres_point import PointType")
+    return "PointType()"
+
+
+# Register the renderer for PointType
+alembic.autogenerate.render.renderers.dispatch_for(PointType, replace=True)(
+    render_point_type
+)
+
+
+# Also register for UserDefinedType as a fallback if the class doesn't match exactly
+@alembic.autogenerate.render.renderers.dispatch_for(UserDefinedType, replace=True)
+def render_user_defined_type(type_, object_, autogen_context):
+    if type(object_).__name__ == "PointType":
+        return render_point_type(type_, object_, autogen_context)
+    return False
+
+
+@alembic.autogenerate.comparators.dispatch_for("schema")
+def compare_point_types(
+    autogen_context: alembic.autogenerate.api.AutogenContext,
+    upgrade_ops: alembic.operations.ops.UpgradeOps,
+    schema_names,
+):
+    """
+    Hook into Alembic's schema comparison to detect PointType usage.
+
+    This ensures the import is added even if PointType is used in existing
+    columns that might not trigger the render hook directly.
+    """
+    pass

{sqlalchemy_postgres_point-0.1.0.dist-info → sqlalchemy_postgres_point-0.2.0.dist-info}/METADATA

@@ -1,15 +1,20 @@
 Metadata-Version: 2.3
 Name: sqlalchemy-postgres-point
-Version: 0.1.0
+Version: 0.2.0
 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
 Author-email: Michael Bianco <mike@mikebian.co>
 Requires-Dist: sqlalchemy>=2.0
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Project-URL: Repository, https://github.com/iloveitaly/sqlalchemy-postgres-point
 Description-Content-Type: text/markdown
 
+[![Release Notes](https://img.shields.io/github/release/iloveitaly/sqlalchemy-postgres-point)](https://github.com/iloveitaly/sqlalchemy-postgres-point/releases)
+[![Downloads](https://static.pepy.tech/badge/sqlalchemy-postgres-point/month)](https://pepy.tech/project/sqlalchemy-postgres-point)
+![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
 =========================
 
@@ -72,6 +77,54 @@ stmt = select(Place.id, Place.location.earth_distance(origin).label("dist"))
 
 The comparator translates `Place.location.earth_distance(origin)` into SQL using the `<@>` operator (requires PostgreSQL with the `cube` / `earthdistance` extension for meaningful results; without extensions the operator may not exist—adapt as needed for your environment). This library only *emits* the operator; it does not manage PostgreSQL extensions.
 
+## PostgreSQL Extensions Setup
+
+To use the earth distance functionality (`earth_distance()` comparator), you need to enable the `cube` and `earthdistance` PostgreSQL extensions. These extensions provide spatial operations for calculating distances between geographic points on Earth's surface using a spherical model.
+
+### Alembic Migration Example
+
+If you're using Alembic for database migrations, you can create a migration to enable these extensions:
+
+```python
+"""Add PostgreSQL extensions for earth distance calculations
+
+Revision ID: your_revision_id
+Revises: your_previous_revision
+Create Date: 2025-01-XX XX:XX:XX.XXXXXX
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+
+# revision identifiers, used by Alembic.
+revision: str = 'your_revision_id'
+down_revision: Union[str, None] = 'your_previous_revision'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+
+def upgrade() -> None:
+    op.execute("""
+CREATE EXTENSION IF NOT EXISTS cube;
+CREATE EXTENSION IF NOT EXISTS earthdistance;
+""")
+
+
+def downgrade() -> None:
+    op.execute("""
+DROP EXTENSION IF EXISTS earthdistance;
+DROP EXTENSION IF EXISTS cube;
+""")
+```
+
+**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
 ----------------------
 
@@ -86,6 +139,33 @@ Run the test suite with:
 uv run pytest -q
 ```
 
+## Alembic Integration
+
+When using `PointType` in your models, you can automatically include the necessary imports in migration files by updating your `alembic/env.py` file.
+
+First, import the integration module:
+
+```python
+import sqlalchemy_postgres_point.alembic_integration
+```
+
+Then, ensure your `context.configure` call includes a `render_item` hook to handle the `PointType`:
+
+```python
+def render_item(type_, obj, autogen_context):
+    if type_ == "type" and type(obj).__name__ == "PointType":
+        return sqlalchemy_postgres_point.alembic_integration.render_point_type(obj, obj, autogen_context)
+    return False
+
+# ... in run_migrations_online and run_migrations_offline ...
+context.configure(
+    # ... other options ...
+    render_item=render_item,
+)
+```
+
+Once added, `from sqlalchemy_postgres_point import PointType` will be automatically included in generated migration files whenever a `PointType` column is detected.
+
 Development
 -----------
 
@@ -114,3 +194,6 @@ 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.2.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+sqlalchemy_postgres_point/__init__.py,sha256=BWlOd4qbAt4fM4cclR7ZrzZ-aib0f13KD3HIKmod2_s,208
+sqlalchemy_postgres_point/alembic_integration.py,sha256=qaMk733hniatgGHwJXl0S5cKIsu_tno4JRvJ_MDLtPs,1840
+sqlalchemy_postgres_point/point.py,sha256=pb_aoNKwMOaKJ_xDvaIhfE-4VZKzyiPgOWmM6_z6xXo,2888
+sqlalchemy_postgres_point/utils.py,sha256=Loc9Q-xkntEKP3WSw48rZr64aqPWdM9huBlJnGuZa_8,1340
+sqlalchemy_postgres_point-0.2.0.dist-info/WHEEL,sha256=QnGI6l9Psotmz6XrseXTYT5jnZRJeTk4SwJP4aLtfdI,80
+sqlalchemy_postgres_point-0.2.0.dist-info/METADATA,sha256=4haIARMrgBsJi5JKaBp01PZ5Cuv8EnHr-ocd6XUL4hA,6367
+sqlalchemy_postgres_point-0.2.0.dist-info/RECORD,,

{sqlalchemy_postgres_point-0.1.0.dist-info → sqlalchemy_postgres_point-0.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: uv 0.8.17
+Generator: uv 0.10.2
 Root-Is-Purelib: true
-Tag: py3-none-any
+Tag: py3-none-any

sqlalchemy_postgres_point-0.1.0.dist-info/RECORD

@@ -1,6 +0,0 @@
-sqlalchemy_postgres_point/__init__.py,sha256=BWlOd4qbAt4fM4cclR7ZrzZ-aib0f13KD3HIKmod2_s,208
-sqlalchemy_postgres_point/point.py,sha256=pb_aoNKwMOaKJ_xDvaIhfE-4VZKzyiPgOWmM6_z6xXo,2888
-sqlalchemy_postgres_point/utils.py,sha256=Loc9Q-xkntEKP3WSw48rZr64aqPWdM9huBlJnGuZa_8,1340
-sqlalchemy_postgres_point-0.1.0.dist-info/WHEEL,sha256=Pi5uDq5Fdo_Rr-HD5h9BiPn9Et29Y9Sh8NhcJNnFU1c,79
-sqlalchemy_postgres_point-0.1.0.dist-info/METADATA,sha256=zPw5cM0f9dCWP_jrYp_WVXEW7TuwTNwXP1EUu10g1u8,3322
-sqlalchemy_postgres_point-0.1.0.dist-info/RECORD,,