tango-python 1.18.1__py3-none-any.whl → 1.19.0__py3-none-any.whl

tango/__init__.py

@@ -62,7 +62,7 @@ from .webhooks import (
 )
 from .webhooks.receiver import Delivery, WebhookReceiver
 
-__version__ = "1.18.1"
+__version__ = "1.19.0"
 __all__ = [
     "TangoClient",
     "TangoAPIError",

tango/client.py

@@ -100,6 +100,10 @@ def _error_reason(error_data: dict[str, Any]) -> str | None:
     return None
 
 
+# Funding-organization keys the metrics endpoints accept in `group_by`.
+MetricsGroupBy = Literal["agency", "department"]
+
+
 class TangoClient:
     """Tango API Client"""
 
@@ -5615,7 +5619,15 @@ class TangoClient:
                 params["flat_lists"] = "true"
         return self._get(f"/api/psc/{code}/", params)
 
-    def get_psc_metrics(self, code: str, months: int, period_grouping: str) -> dict[str, Any]:
+    def get_psc_metrics(
+        self,
+        code: str,
+        months: int,
+        period_grouping: str,
+        group_by: MetricsGroupBy | list[MetricsGroupBy] | None = None,
+        fiscal_year: bool = False,
+        rolling: bool = False,
+    ) -> dict[str, Any]:
         """Get rolling PSC metrics (`/api/psc/{code}/metrics/{months}/{period_grouping}/`).
 
         Args:
@@ -5623,10 +5635,32 @@ class TangoClient:
             months: Window size in months (e.g. 6, 12, 24, 36).
             period_grouping: ``"month"``, ``"quarter"``, or ``"year"`` (the
                 values the API accepts on the path segment).
+            group_by: Split each period by the funding ``"agency"`` (an L2 short code such as ``"2100"``) or ``"department"`` (the CGAC code as an int, e.g. ``97`` for DoD), or both.
+            fiscal_year: Bucket by federal fiscal year (October-September) instead of calendar periods.
+            rolling: Add rolling averages. The API skips them, with a ``warning``, when ``group_by`` is set.
         """
         if not code:
             raise TangoValidationError("PSC code is required")
-        return self._get(f"/api/psc/{code}/metrics/{months}/{period_grouping}/")
+        return self._get(
+            f"/api/psc/{code}/metrics/{months}/{period_grouping}/",
+            self._metrics_params(group_by, fiscal_year, rolling),
+        )
+
+    @staticmethod
+    def _metrics_params(
+        group_by: MetricsGroupBy | list[MetricsGroupBy] | None,
+        fiscal_year: bool,
+        rolling: bool,
+    ) -> dict[str, Any]:
+        """Query params shared by the entity, NAICS and PSC metrics endpoints."""
+        params: dict[str, Any] = {}
+        if group_by:
+            params["group_by"] = group_by if isinstance(group_by, str) else ",".join(group_by)
+        if fiscal_year:
+            params["fiscal_year"] = "true"
+        if rolling:
+            params["rolling"] = "true"
+        return params
 
     def get_naics(
         self,
@@ -5647,11 +5681,25 @@ class TangoClient:
                 params["flat_lists"] = "true"
         return self._get(f"/api/naics/{code}/", params)
 
-    def get_naics_metrics(self, code: str, months: int, period_grouping: str) -> dict[str, Any]:
-        """Get rolling NAICS metrics (`/api/naics/{code}/metrics/{months}/{period_grouping}/`)."""
+    def get_naics_metrics(
+        self,
+        code: str,
+        months: int,
+        period_grouping: str,
+        group_by: MetricsGroupBy | list[MetricsGroupBy] | None = None,
+        fiscal_year: bool = False,
+        rolling: bool = False,
+    ) -> dict[str, Any]:
+        """Get rolling NAICS metrics (`/api/naics/{code}/metrics/{months}/{period_grouping}/`).
+
+        Takes the same ``group_by``, ``fiscal_year`` and ``rolling`` options as :meth:`get_psc_metrics`.
+        """
         if not code:
             raise TangoValidationError("NAICS code is required")
-        return self._get(f"/api/naics/{code}/metrics/{months}/{period_grouping}/")
+        return self._get(
+            f"/api/naics/{code}/metrics/{months}/{period_grouping}/",
+            self._metrics_params(group_by, fiscal_year, rolling),
+        )
 
     def get_business_type(
         self,
@@ -6026,13 +6074,26 @@ class TangoClient:
             meta=data.get("meta"),
         )
 
-    def get_entity_metrics(self, uei: str, months: int, period_grouping: str) -> dict[str, Any]:
+    def get_entity_metrics(
+        self,
+        uei: str,
+        months: int,
+        period_grouping: str,
+        group_by: MetricsGroupBy | list[MetricsGroupBy] | None = None,
+        fiscal_year: bool = False,
+        rolling: bool = False,
+    ) -> dict[str, Any]:
         """Get rolling metrics for an entity
         (`/api/entities/{uei}/metrics/{months}/{period_grouping}/`).
+
+        Takes the same ``group_by``, ``fiscal_year`` and ``rolling`` options as :meth:`get_psc_metrics`.
         """
         if not uei:
             raise TangoValidationError("UEI is required")
-        return self._get(f"/api/entities/{uei}/metrics/{months}/{period_grouping}/")
+        return self._get(
+            f"/api/entities/{uei}/metrics/{months}/{period_grouping}/",
+            self._metrics_params(group_by, fiscal_year, rolling),
+        )
 
     # ============================================================================
     # IDV sub-resources

tango/exceptions.py

@@ -1,7 +1,11 @@
 """Tango API exceptions"""
 
+import re
 from typing import Any
 
+# The API names the tripped rate in its 429 detail: "Rate limit exceeded for daily. Please try again in 16 hours, 58 minutes."
+_RATE_NAME = re.compile(r"exceeded for ([\w-]+)", re.IGNORECASE)
+
 
 class TangoAPIError(Exception):
     """Base exception for Tango API errors"""
@@ -88,11 +92,13 @@ class TangoRateLimitError(TangoAPIError):
         d = self.detail
         if not d:
             return None
-        lower = d.lower()
-        if "burst" in lower or "minute" in lower:
-            return "burst"
-        if "daily" in lower or "day" in lower:
+        # Read the rate's name, not the whole sentence: a daily lockout's wait reads "16 hours, 58 minutes", which a match on "minute" took for burst.
+        match = _RATE_NAME.search(d)
+        text = match.group(1).lower() if match else d.lower()
+        if "daily" in text or re.search(r"\bday\b", text):
             return "daily"
+        if "burst" in text or "minute" in text:
+            return "burst"
         return None
 
 

{tango_python-1.18.1.dist-info → tango_python-1.19.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tango-python
-Version: 1.18.1
+Version: 1.19.0
 Summary: Python SDK for the Tango API
 Project-URL: Homepage, https://github.com/makegov/tango-python
 Project-URL: Documentation, https://docs.makegov.com/tango-python

{tango_python-1.18.1.dist-info → tango_python-1.19.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
-tango/__init__.py,sha256=VqhIYcfNI56Lx8iBaT3qGYKpjaHxLWPpTC-fIujYxQA,2739
-tango/client.py,sha256=awauFCq-gd-dCBAvDPeEBBgxwhuc_2ZzIhK-I7ki0U8,245711
-tango/exceptions.py,sha256=oPiLCccBoWLK5SjHkzP-oI6mUD9twEeKSvEuLV5h01I,4224
+tango/__init__.py,sha256=EM6Jq21IN9wUKCXR7DsHJFuseDT8AqktTOS59qaXm9w,2739
+tango/client.py,sha256=2zQb486CL9sClQOJlua1nI_AnRFT1zUjeEikv_t_Cc4,247811
+tango/exceptions.py,sha256=TL2MrSbcy99ogrJugLiP1I5J5qNih770knISycDTx-g,4661
 tango/models.py,sha256=D9e8_AAAwVi1C4nOqdhWz-8ARBLPRsLGi8TDjucOMEY,72897
 tango/shapes/__init__.py,sha256=7ea1WU74jp4znhNw-gXruag6m6eyPZtbVgbDFmFUWro,1072
 tango/shapes/explicit_schemas.py,sha256=fwjHiFLOMpFyNLNM4M6kdK603s-t8gxHYqcSeL3jz7g,85674
@@ -16,8 +16,8 @@ tango/webhooks/cli.py,sha256=f_vQbJ2AeSQjKnQo7MxHFyUB2SAKcgHYmGQULS0isqQ,13858
 tango/webhooks/receiver.py,sha256=5yhsVhlLyoxmOCGvmbynWAIlDB2OaCPVf1H4GA1SxmU,9279
 tango/webhooks/signing.py,sha256=92Ee-0B6PR7ZkvY3Np3gzl88-mtfKkh-I7lxqCe2lGw,2374
 tango/webhooks/simulate.py,sha256=g2Osa0FYU5mJuon07T2aUCtmkUoTEzsY261tlp76fF0,3165
-tango_python-1.18.1.dist-info/METADATA,sha256=WL8McHrCjg-DuQ2-9FLyb9DyQZge8oSMnNXFCQhY_Nw,22824
-tango_python-1.18.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-tango_python-1.18.1.dist-info/entry_points.txt,sha256=kGLUbglUjuaAqEFvOZ1QuSW0vWb6VeSpCIFKaOFkKoQ,50
-tango_python-1.18.1.dist-info/licenses/LICENSE,sha256=j2kYVHMwTkoGn3ZNScnrdIueG0k2XzB_LCPFoyBc2wk,1064
-tango_python-1.18.1.dist-info/RECORD,,
+tango_python-1.19.0.dist-info/METADATA,sha256=IBq0ckYVquUbejqTc115sets4upLdf9aZOIKtJWEYBo,22824
+tango_python-1.19.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+tango_python-1.19.0.dist-info/entry_points.txt,sha256=kGLUbglUjuaAqEFvOZ1QuSW0vWb6VeSpCIFKaOFkKoQ,50
+tango_python-1.19.0.dist-info/licenses/LICENSE,sha256=j2kYVHMwTkoGn3ZNScnrdIueG0k2XzB_LCPFoyBc2wk,1064
+tango_python-1.19.0.dist-info/RECORD,,