permisapi-client 0.7.0__tar.gz → 0.7.2__tar.gz

{permisapi_client-0.7.0 → permisapi_client-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: permisapi-client
-Version: 0.7.0
+Version: 0.7.2
 Summary: Client Python officiel pour PermisAPI : permis de construire France en API REST.
 Project-URL: Homepage, https://permisapi.fr
 Project-URL: Documentation, https://permisapi.fr/docs

{permisapi_client-0.7.0 → permisapi_client-0.7.2}/permisapi_client/__init__.py

@@ -30,4 +30,4 @@ __all__ = [
     "PermisAPIValidationError",
 ]
 
-__version__ = "0.7.0"
+__version__ = "0.7.2"

{permisapi_client-0.7.0 → permisapi_client-0.7.2}/permisapi_client/client.py

@@ -13,7 +13,7 @@ from permisapi_client.exceptions import error_from_response
 
 DEFAULT_BASE_URL = "https://api.permisapi.fr"
 DEFAULT_TIMEOUT = 15.0
-USER_AGENT = "permisapi-client-python/0.7.0"
+USER_AGENT = "permisapi-client-python/0.7.2"
 
 
 def _raise_for_status(resp: httpx.Response) -> None:
@@ -52,7 +52,25 @@ class _PermitsResource:
         self._c = client
 
     def list(self, **params: Any) -> dict[str, Any]:
-        """GET /v1/permits avec filtres. Retourne {items, pagination}."""
+        """GET /v1/permits avec filtres. Retourne {data, pagination}.
+
+        Filtres acceptes : dep_code, comm_code, localite, codpost,
+        permit_type, etat_pa, an_depot, date_from, date_to,
+        min_superficie, siren, geocoded_only, page, limit.
+
+        Tri : passer `sort="-date_reelle_autorisation"` (defaut),
+        `sort="date_depot"`, `sort="-superficie_terrain"`, etc.
+        Champs autorises : date_reelle_autorisation, date_depot,
+        an_depot, superficie_terrain. Prefixe `-` pour descendant.
+        Tout autre champ retourne 422 (et non ignore silencieusement).
+
+        Filtre `min_score` (Pro+ uniquement) : retourne uniquement les
+        permits avec un Score Opportunite MDB >= N (0-100). Use case
+        marchand de biens : shortliste les top opportunites en 1 call
+        au lieu de fetch + filter cote client. Cout quota special :
+        `limit` unites au lieu de 1 (anti-abus, equivalent a N calls
+        /score). Header X-RateLimit-Cost confirme.
+        """
         return self._c._get("/v1/permits", params=params)
 
     def iter_all(self, **params: Any) -> Iterator[dict[str, Any]]:
@@ -462,6 +480,8 @@ class _AsyncPermitsResource:
         self._c = client
 
     async def list(self, **params: Any) -> dict[str, Any]:
+        """GET /v1/permits avec filtres. Voir _PermitsResource.list pour
+        la doc complete (filtres + tri sort=)."""
         return await self._c._get("/v1/permits", params=params)
 
     async def iter_all(self, **params: Any) -> AsyncIterator[dict[str, Any]]:

{permisapi_client-0.7.0 → permisapi_client-0.7.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "permisapi-client"
-version = "0.7.0"
+version = "0.7.2"
 description = "Client Python officiel pour PermisAPI : permis de construire France en API REST."
 readme = "README.md"
 requires-python = ">=3.9"

{permisapi_client-0.7.0 → permisapi_client-0.7.2}/tests/test_client.py

@@ -337,6 +337,24 @@ async def test_async_permits_export() -> None:
     assert b"PC-A,75" in result
 
 
+@respx.mock
+def test_permits_list_with_sort() -> None:
+    """SDK propagates `sort=` query param transparently to the API."""
+    route = respx.get(f"{BASE}/v1/permits").respond(
+        json={
+            "data": [{"num_pa": "PC-1", "superficie_terrain": 1500}],
+            "pagination": {"page": 1, "total": 1, "pages": 1},
+        }
+    )
+    with PermisAPI(api_key="pk_test_abc") as client:
+        client.permits.list(dep_code="33", sort="-superficie_terrain", limit=10)
+    assert route.called
+    # The sort param must appear in the request URL query string
+    url = str(route.calls.last.request.url)
+    assert "sort=-superficie_terrain" in url
+    assert "dep_code=33" in url
+
+
 @respx.mock
 def test_permits_full_view_sync() -> None:
     """Sync : full_view appelle GET /v1/permits/{num_pa}/360 et retourne