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

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

@@ -1,15 +1,20 @@
 Metadata-Version: 2.3
 Name: sqlalchemy-postgres-point
-Version: 0.1.0
+Version: 0.1.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
 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
 ----------------------
 
@@ -114,3 +167,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.1.0 → sqlalchemy_postgres_point-0.1.1}/README.md

@@ -1,3 +1,8 @@
+[![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
 =========================
 
@@ -60,6 +65,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
 ----------------------
 
@@ -102,3 +155,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.1.0 → sqlalchemy_postgres_point-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sqlalchemy-postgres-point"
-version = "0.1.0"
+version = "0.1.1"
 description = "Lightweight SQLAlchemy custom type for PostgreSQL POINT columns with tuple binding and an earth-distance comparator."
 keywords = [
     "sqlalchemy",
@@ -14,14 +14,14 @@ keywords = [
     "earthdistance",
 ]
 readme = "README.md"
-requires-python = ">=3.10"
+requires-python = ">=3.12"
 dependencies = ["sqlalchemy>=2.0"]
 authors = [{ name = "Michael Bianco", email = "mike@mikebian.co" }]
 urls = { "Repository" = "https://github.com/iloveitaly/sqlalchemy-postgres-point" }
 
 
 [build-system]
-requires = ["uv_build>=0.8.11,<0.9.0"]
+requires = ["uv_build>=0.10.0"]
 build-backend = "uv_build"
 
 [tool.uv.build-backend]
@@ -30,8 +30,29 @@ module-root = ""
 
 [dependency-groups]
 dev = [
-    "pytest>=8.3.3",
-    "sqlmodel>=0.0.21",
+    "pytest>=8.3.4",
+    "sqlmodel>=0.0.32",
     "psycopg[binary]>=3.2.0",
-    "activemodel",
+    "activemodel>=0.15.0",
+    "pyright[nodejs]>=1.1.408",
+    "ruff>=0.15.0",
+    "coverage>=7.13.4",
+    "pytest-cov>=7.0.0",
+    "covdefaults>=2.3.0",
 ]
+
+[tool.pyright]
+exclude = ["examples/", "playground/", "tmp/", ".venv/", "tests/"]
+
+[tool.pytest.ini_options]
+addopts = "--cov --cov-report=term-missing --cov-report=html:tmp/htmlcov"
+
+[tool.coverage.run]
+plugins = ["covdefaults"]
+source = ["sqlalchemy_postgres_point"]
+
+[tool.coverage.report]
+fail_under = 50
+
+[tool.ruff]
+extend-exclude = ["playground.py", "playground/"]