tango-python 1.7.0__tar.gz → 1.8.0__tar.gz

{tango_python-1.7.0 → tango_python-1.8.0}/CHANGELOG.md

@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.8.0] - 2026-09-28
+
+### Added
+- **Federal Register documents** (Tango API 5.3.0). Two methods over the new `/api/federal_register/` resource: `list_federal_register_documents()` and `get_federal_register_document()`, plus a `FederalRegisterDocument` schema and the `FEDERAL_REGISTER_MINIMAL` / `FEDERAL_REGISTER_COMPREHENSIVE` defaults. These are the rules, proposed rules, notices and presidential documents published in the Federal Register since 1994. All seventeen of the API's filters are explicit named parameters, including `comments_open`, `cfr_title` / `cfr_part`, `rin`, and both `agency` (a Tango organization, including its sub-agencies) and `fr_agency` (the Federal Register's own agency slug).
+
+  `get_federal_register_document()` takes the document's `uuid`, not its `document_number`, because a document number is not unique on its own: the Federal Register reused some before 2016. Look a document up by number with `list_federal_register_documents(document_number=...)`. `full_text` is available on the detail method only when named in `shape`, and neither default shape includes it, since it can run to several MB. `ordering="rank"` requires a non-empty `search`, matching the API.
+- **`alerts.federal_register.match` is an alertable event type.** `create_webhook_alert(query_type="federal_register", ...)` works.
+- **`agency` filter on `list_budget_accounts()`, `list_exclusions()` and `list_itdashboard_investments()`** (Tango API 5.3.0). It takes a Tango agency name, abbreviation, code or organization key (e.g. `EPA`) and matches the whole organization subtree, so a department includes its sub-agencies; OR several with `|`. On exclusions it scopes by the excluding agency. On IT Dashboard it is available at every plan.
+- **The `organization` expand is accepted on budget accounts, exclusions, SBIR topics and SBIR solicitations**, along with the `organization_id` field on budget accounts and exclusions. `organization(...)` carries `agency_code`, `agency_name`, `department_code`, `department_name`, `office_code`, `office_name` and `organization_id`. The SDK rejected these shapes client-side before. The default shapes are unchanged.
+
+### Fixed
+- **`list_itdashboard_investments()` documents the API's current filter tiers.** `agency_name` is available at every plan, not Business+ only.
+
 ## [1.7.0] - 2026-09-23
 
 ### Added

{tango_python-1.7.0 → tango_python-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: tango-python
-Version: 1.7.0
+Version: 1.8.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.7.0 → tango_python-1.8.0}/docs/API_REFERENCE.md

@@ -23,6 +23,7 @@ Complete reference for all Tango Python SDK methods and functionality.
 - [GSA eLibrary Contracts](#gsa-elibrary-contracts)
 - [Protests](#protests)
 - [Contract Appeals](#contract-appeals)
+- [Federal Register](#federal-register)
 - [Budget](#budget)
 - [Business Types](#business-types)
 - [NAICS](#naics)
@@ -1315,6 +1316,93 @@ appeal = client.get_contract_appeal(
 
 ---
 
+## Federal Register
+
+Federal Register documents — rules, proposed rules, notices and presidential documents published since 1994.
+
+A document is identified by `uuid`. `document_number` is not unique on its own: the Federal Register reused some numbers before 2016, so `document_number=` can return more than one document.
+
+### list_federal_register_documents()
+
+List documents with filtering and shaping.
+
+```python
+documents = client.list_federal_register_documents(
+    page=1,
+    limit=25,
+    shape=ShapeConfig.FEDERAL_REGISTER_MINIMAL,
+    # Filter parameters (all optional)
+    search=None,
+    document_number=None,
+    type=None,
+    agency=None,
+    fr_agency=None,
+    publication_date_after=None,
+    publication_date_before=None,
+    effective_on_after=None,
+    effective_on_before=None,
+    comments_close_on_after=None,
+    comments_close_on_before=None,
+    comments_open=None,
+    cfr_title=None,
+    cfr_part=None,
+    significant=None,
+    rin=None,
+    executive_order_number=None,
+    ordering=None,
+)
+```
+
+**Filter Parameters:**
+- `search` - Ranked full-text search over the title, abstract and action; wrap in double quotes for a phrase
+- `document_number` - Exact FR document number, e.g. `"2016-31922"`; OR several with `|`
+- `type` - `"Notice"`, `"Rule"`, `"Proposed Rule"`, `"Presidential Document"`, `"Correction"`, `"Sunshine Act Document"` or `"Uncategorized Document"` (case-insensitive); OR several with `|`. An unknown type is an error, not an empty page. Documents published before 2008 are mostly `Uncategorized Document`, so a type filter undercounts that era
+- `agency` - A Tango agency name, abbreviation, code or organization key, e.g. `"EPA"`. Matches a document when any agency it lists falls within that organization, so a department includes its sub-agencies; OR several with `|`
+- `fr_agency` - The Federal Register's own agency slug, e.g. `"environmental-protection-agency"`; OR several with `|`
+- `publication_date_after` / `publication_date_before` - Publication date range (`YYYY-MM-DD`)
+- `effective_on_after` / `effective_on_before` - Effective date range (`YYYY-MM-DD`)
+- `comments_close_on_after` / `comments_close_on_before` - Comment-deadline range (`YYYY-MM-DD`)
+- `comments_open` - `True` for documents whose comment period closes today or later, `False` for those already closed; documents with no comment deadline match neither
+- `cfr_title` - A CFR title number, e.g. `"40"`
+- `cfr_part` - A CFR part number, e.g. `"52"`. Requires `cfr_title`, and both must match the same CFR reference, so `cfr_title="40", cfr_part="52"` finds 40 CFR 52
+- `significant` - Significant under Executive Order 12866
+- `rin` - A Regulation Identifier Number, e.g. `"2060-AV16"`; OR several with `|`
+- `executive_order_number` - Exact executive order number
+- `ordering` - `publication_date` (the default, as `-publication_date`), `effective_on`, `comments_close_on`, `document_number` or `rank`. `rank` requires a non-empty `search`
+
+**Returns:** [PaginatedResponse](#paginatedresponse) with document dictionaries
+
+**Example:**
+```python
+documents = client.list_federal_register_documents(
+    type="Proposed Rule",
+    comments_open=True,
+    agency="EPA",
+    limit=25,
+)
+
+for doc in documents.results:
+    print(f"{doc['document_number']} ({doc['publication_date']}): {doc['title']}")
+    print(f"  comments close {doc['comments_close_on']}")
+```
+
+### get_federal_register_document()
+
+Get a single document by `uuid`. To look one up by its document number, use `list_federal_register_documents(document_number=...)`.
+
+```python
+document = client.get_federal_register_document(
+    "DOCUMENT_UUID",
+    shape=ShapeConfig.FEDERAL_REGISTER_COMPREHENSIVE,
+)
+```
+
+**Notes:**
+- `agencies`, `cfr_references`, `dockets` and `topics` are the Federal Register's own structures, served as published. `agencies` carries Federal Register agency slugs, not Tango organization keys.
+- `full_text`, the document's plain text, is available on this method only and only when named in `shape` (e.g. `shape="uuid,title,full_text"`). It can run to several MB, so neither default shape includes it.
+
+---
+
 ## State & Local (SLED)
 
 State, local and education procurement — solicitations that never appear on SAM.gov because they were never federal. **Beta**: coverage is partial and grows one jurisdiction at a time.
@@ -2311,6 +2399,8 @@ entity = client.get_entity("UEI_KEY", shape=ShapeConfig.ENTITIES_COMPREHENSIVE)
 | `PROTESTS_MINIMAL` | `list_protests` | case_id, case_number, title, source_system, outcome, filed_date |
 | `CONTRACT_APPEALS_MINIMAL` | `list_contract_appeals` | uuid, board, docket_numbers, decision_date, appellant, judge, decision_type, url |
 | `CONTRACT_APPEALS_COMPREHENSIVE` | `get_contract_appeal` | The list fields plus docket_raw, docket_source, decision_date_repaired, decision_type_raw, listing_year, first_listed_at, listed, text_status, text_char_count (omits `decision_text`, which needs an Enterprise plan) |
+| `FEDERAL_REGISTER_MINIMAL` | `list_federal_register_documents` | uuid, document_number, publication_date, type, subtype, title, abstract, action, agencies, cfr_references, citation, significant, comments_close_on, effective_on, html_url, pdf_url |
+| `FEDERAL_REGISTER_COMPREHENSIVE` | `get_federal_register_document` | The list fields plus dates, signing_date, start_page, end_page, volume, docket_ids, dockets, regulation_id_numbers, topics, correction_of, corrections, executive_order_number, presidential_document_number, proclamation_number, comment_url, regulations_dot_gov_url, raw_text_url, body_html_url (omits `full_text`) |
 | `BUDGET_ACCOUNTS_MINIMAL` | `list_budget_accounts`, `get_budget_account` | id, federal_account_symbol, fiscal_year, agency_code/name, bureau_name, account_title, bea_category, on_off_budget, subfunction_code, lifecycle (requested/enacted/apportioned/obligated/outlayed/unobligated), contract & assistance rollups, key ratios, next-year growth |
 | `VEHICLE_ORDERS_MINIMAL` | `list_vehicle_orders` | key, piid, award_date, recipient(display_name,uei), total_contract_value, obligated |
 | `ITDASHBOARD_INVESTMENTS_MINIMAL` | `list_itdashboard_investments` | Minimal IT Dashboard investment fields |

{tango_python-1.7.0 → tango_python-1.8.0}/docs/WEBHOOKS.md

@@ -89,6 +89,7 @@ tango webhooks list-event-types
 # alerts.dibbs_rfp.match     DLA DIBBS RFP matched a saved alert
 # alerts.sled_opportunity.match  State/local/education solicitation matched a saved alert
 # alerts.contract_appeal.match  CBCA/ASBCA appeal decision matched a saved alert
+# alerts.federal_register.match  Federal Register document matched a saved alert
 ```
 
 This list is served by the API, so it is always current — the SDK does not hardcode

{tango_python-1.7.0 → tango_python-1.8.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "tango-python"
-version = "1.7.0"
+version = "1.8.0"
 description = "Python SDK for the Tango API"
 readme = "README.md"
 requires-python = ">=3.12"

{tango_python-1.7.0 → tango_python-1.8.0}/scripts/check_filter_shape_conformance.py

@@ -78,6 +78,7 @@ RESOURCE_TO_METHOD: dict[str, str | None] = {
     "sled/forecasts": "list_sled_forecasts",
     "protests": "list_protests",
     "contract_appeals": "list_contract_appeals",
+    "federal_register": "list_federal_register_documents",
     "offices": "list_offices",
     "psc": "list_psc",
     "mas_sins": "list_mas_sins",

{tango_python-1.7.0 → tango_python-1.8.0}/scripts/check_shape_coverage.py

@@ -69,6 +69,7 @@ RESOURCE_TO_MODEL: dict[str, str] = {
     "budget_accounts": "BudgetAccount",
     "protests": "Protest",
     "contract_appeals": "ContractAppeal",
+    "federal_register": "FederalRegisterDocument",
     "offices": "Office",
     "assistance_listings": "AssistanceListing",
     "business_types": "BusinessType",

{tango_python-1.7.0 → tango_python-1.8.0}/tango/__init__.py

@@ -15,6 +15,7 @@ from .models import (
     DibbsRfp,
     DibbsRfq,
     Exclusion,
+    FederalRegisterDocument,
     GsaElibraryContract,
     ITDashboardInvestment,
     PaginatedResponse,
@@ -54,7 +55,7 @@ from .webhooks import (
 )
 from .webhooks.receiver import Delivery, WebhookReceiver
 
-__version__ = "1.7.0"
+__version__ = "1.8.0"
 __all__ = [
     "TangoClient",
     "TangoAPIError",
@@ -67,6 +68,7 @@ __all__ = [
     "ResolveResult",
     "BudgetAccount",
     "ContractAppeal",
+    "FederalRegisterDocument",
     "DibbsAward",
     "DibbsRfp",
     "DibbsRfq",

{tango_python-1.7.0 → tango_python-1.8.0}/tango/client.py

@@ -30,6 +30,7 @@ from tango.models import (
     DibbsRfq,
     Entity,
     Exclusion,
+    FederalRegisterDocument,
     Forecast,
     Grant,
     GsaElibraryContract,
@@ -1601,18 +1602,18 @@ class TangoClient:
         cio_rating_max: int | None = None,
         performance_risk: bool | None = None,
         previous_uii: str | None = None,
+        agency: str | None = None,
     ) -> PaginatedResponse:
         """List federal IT investments from the IT Dashboard (`/api/itdashboard/`).
 
         Filters are tier-gated by the API:
 
-        - **Free**: ``search`` (full-text across UII, title, description, agency,
-          bureau) and ``previous_uii`` — following a retired identifier forward to
-          whatever superseded it is recovery, not analysis, so it is ungated
+        - **Free**: ``search`` (full-text across UII, title, description, agency, bureau), ``agency_name`` (text), ``agency`` and ``previous_uii`` — following a retired identifier forward to whatever superseded it is recovery, not analysis, so it is ungated
         - **Pro**: ``agency_code``, ``type_of_investment``,
           ``updated_time_after`` / ``updated_time_before``
-        - **Business+**: ``agency_name`` (text), ``cio_rating``,
-          ``cio_rating_max``, ``performance_risk``
+        - **Business+**: ``cio_rating``, ``cio_rating_max``, ``performance_risk``
+
+        ``agency`` takes a Tango agency name, abbreviation, code or organization key, e.g. ``DOT``, and matches the whole organization subtree, so a department includes its sub-agencies. OR several with ``|``.
 
         Hitting a gated filter on a lower tier returns a 403 with upgrade info.
 
@@ -1632,6 +1633,7 @@ class TangoClient:
                 params["flat_lists"] = "true"
         for k, val in (
             ("search", search),
+            ("agency", agency),
             ("agency_code", agency_code),
             ("agency_name", agency_name),
             ("type_of_investment", type_of_investment),
@@ -2818,6 +2820,149 @@ class TangoClient:
         data = self._get(f"/api/contract_appeals/{appeal_id}/", params)
         return self._parse_response_with_shape(data, shape, ContractAppeal, flat, flat_lists)
 
+    # ============================================================================
+    # Federal Register documents
+    # ============================================================================
+
+    def list_federal_register_documents(
+        self,
+        page: int = 1,
+        limit: int = 25,
+        shape: str | None = None,
+        flat: bool = False,
+        flat_lists: bool = False,
+        search: str | None = None,
+        document_number: str | None = None,
+        type: str | None = None,
+        agency: str | None = None,
+        fr_agency: str | None = None,
+        publication_date_after: str | None = None,
+        publication_date_before: str | None = None,
+        effective_on_after: str | None = None,
+        effective_on_before: str | None = None,
+        comments_close_on_after: str | None = None,
+        comments_close_on_before: str | None = None,
+        comments_open: bool | None = None,
+        cfr_title: str | None = None,
+        cfr_part: str | None = None,
+        significant: bool | None = None,
+        rin: str | None = None,
+        executive_order_number: str | None = None,
+        ordering: str | None = None,
+    ) -> PaginatedResponse:
+        """
+        List Federal Register documents.
+
+        Rules, proposed rules, notices and presidential documents published in the Federal Register since 1994.
+
+        Args:
+            page: Page number
+            limit: Results per page (max 100)
+            shape: Response shape string (defaults to minimal shape)
+            flat: If True, flatten nested objects in shaped response
+            flat_lists: If True, flatten arrays using indexed keys
+            search: Ranked full-text search over the title, abstract and action. Wrap in double quotes for a phrase
+            document_number: Exact FR document number, e.g. ``2016-31922``. OR several with ``|``. A number the Federal Register reused before 2016 matches every document that carries it
+            type: ``Notice``, ``Rule``, ``Proposed Rule``, ``Presidential Document``, ``Correction``, ``Sunshine Act Document`` or ``Uncategorized Document`` (case-insensitive). OR several with ``|``. Documents published before 2008 are mostly ``Uncategorized Document``
+            agency: A Tango agency name, abbreviation, code or organization key, e.g. ``EPA``. Matches a document when any agency it lists falls within that organization, so a department includes its sub-agencies. OR several with ``|``
+            fr_agency: The Federal Register's own agency slug, e.g. ``environmental-protection-agency``. OR several with ``|``
+            publication_date_after: Published on or after (YYYY-MM-DD)
+            publication_date_before: Published on or before (YYYY-MM-DD)
+            effective_on_after: Effective on or after (YYYY-MM-DD)
+            effective_on_before: Effective on or before (YYYY-MM-DD)
+            comments_close_on_after: Comment period closes on or after (YYYY-MM-DD)
+            comments_close_on_before: Comment period closes on or before (YYYY-MM-DD)
+            comments_open: ``True`` for documents whose comment period closes today or later, ``False`` for those already closed. Documents with no comment deadline match neither
+            cfr_title: A CFR title number, e.g. ``40``
+            cfr_part: A CFR part number, e.g. ``52``. Requires ``cfr_title``, and both must match the same CFR reference
+            significant: Significant under Executive Order 12866
+            rin: A Regulation Identifier Number, e.g. ``2060-AV16``. OR several with ``|``
+            executive_order_number: Exact executive order number
+            ordering: Sort field — ``publication_date`` (the default, as ``-publication_date``), ``effective_on``, ``comments_close_on``, ``document_number`` or ``rank``. ``rank`` requires a non-empty ``search``
+        """
+        params: dict[str, Any] = {"page": page, "limit": min(limit, 100)}
+
+        if shape is None:
+            shape = ShapeConfig.FEDERAL_REGISTER_MINIMAL
+        if shape:
+            params["shape"] = shape
+            if flat:
+                params["flat"] = "true"
+            if flat_lists:
+                params["flat_lists"] = "true"
+
+        for key, val in (
+            ("search", search),
+            ("document_number", document_number),
+            ("type", type),
+            ("agency", agency),
+            ("fr_agency", fr_agency),
+            ("publication_date_after", publication_date_after),
+            ("publication_date_before", publication_date_before),
+            ("effective_on_after", effective_on_after),
+            ("effective_on_before", effective_on_before),
+            ("comments_close_on_after", comments_close_on_after),
+            ("comments_close_on_before", comments_close_on_before),
+            ("comments_open", comments_open),
+            ("cfr_title", cfr_title),
+            ("cfr_part", cfr_part),
+            ("significant", significant),
+            ("rin", rin),
+            ("executive_order_number", executive_order_number),
+            ("ordering", ordering),
+        ):
+            if val is not None:
+                params[key] = val
+
+        data = self._get("/api/federal_register/", params)
+
+        results = [
+            self._parse_response_with_shape(item, shape, FederalRegisterDocument, flat, flat_lists)
+            for item in data["results"]
+        ]
+
+        return PaginatedResponse(
+            count=data["count"],
+            next=data.get("next"),
+            previous=data.get("previous"),
+            results=results,
+            meta=data.get("meta"),
+        )
+
+    def get_federal_register_document(
+        self,
+        document_uuid: str,
+        shape: str | None = None,
+        flat: bool = False,
+        flat_lists: bool = False,
+    ) -> Any:
+        """
+        Get a single Federal Register document by uuid.
+
+        The detail route takes the document's ``uuid``, not its ``document_number``, which is not unique on its own.
+        To look a document up by number, use ``list_federal_register_documents(document_number=...)``.
+
+        Args:
+            document_uuid: Document UUID
+            shape: Response shape string (defaults to the comprehensive shape). Name ``full_text`` here to get the document's plain text, which can run to several MB
+            flat: If True, flatten nested objects in shaped response
+            flat_lists: If True, flatten arrays using indexed keys
+        """
+        params: dict[str, Any] = {}
+        if shape is None:
+            shape = ShapeConfig.FEDERAL_REGISTER_COMPREHENSIVE
+        if shape:
+            params["shape"] = shape
+            if flat:
+                params["flat"] = "true"
+            if flat_lists:
+                params["flat_lists"] = "true"
+
+        data = self._get(f"/api/federal_register/{document_uuid}/", params)
+        return self._parse_response_with_shape(
+            data, shape, FederalRegisterDocument, flat, flat_lists
+        )
+
     # ============================================================================
     # DLA DIBBS (RFQs, RFPs, awards)
     # ============================================================================
@@ -3242,6 +3387,7 @@ class TangoClient:
         update_date_before: str | None = None,
         search: str | None = None,
         ordering: str | None = None,
+        agency: str | None = None,
     ) -> PaginatedResponse:
         """
         List SAM.gov exclusion (debarment) records.
@@ -3261,6 +3407,7 @@ class TangoClient:
             classification_type: Filter by classification (Firm, Individual, Vessel, ...)
             exclusion_type: Filter by exclusion type
             exclusion_program: Filter by exclusion program
+            agency: Excluding agency as a Tango organization. A Tango agency name, abbreviation, code or organization key, e.g. ``EPA``. Matches the whole organization subtree, so a department includes its sub-agencies. OR several with ``|``
             excluding_agency_code: Filter by excluding agency code
             excluding_agency_name: Filter by excluding agency name
             active: True returns only records currently in effect.
@@ -3296,6 +3443,7 @@ class TangoClient:
             ("classification_type", classification_type),
             ("exclusion_type", exclusion_type),
             ("exclusion_program", exclusion_program),
+            ("agency", agency),
             ("excluding_agency_code", excluding_agency_code),
             ("excluding_agency_name", excluding_agency_name),
             ("active", active),
@@ -4153,6 +4301,7 @@ class TangoClient:
         actual_vs_requested_contract_capped_lte: float | None = None,
         search: str | None = None,
         ordering: str | None = None,
+        agency: str | None = None,
     ) -> PaginatedResponse:
         """List budget accounts (`/api/budget/accounts/`).
 
@@ -4170,6 +4319,7 @@ class TangoClient:
             fiscal_year: Fiscal year (exact).
             fiscal_year_gte: Fiscal year >=.
             fiscal_year_lte: Fiscal year <=.
+            agency: A Tango agency name, abbreviation, code or organization key, e.g. ``EPA``. Matches the whole organization subtree, so a department includes its sub-agencies. OR several with ``|``.
             agency_code: Agency code (exact).
             bureau_name: Bureau name (exact).
             account_title: Account title (icontains).
@@ -4234,6 +4384,7 @@ class TangoClient:
             ("fiscal_year", fiscal_year),
             ("fiscal_year__gte", fiscal_year_gte),
             ("fiscal_year__lte", fiscal_year_lte),
+            ("agency", agency),
             ("agency_code", agency_code),
             ("bureau_name", bureau_name),
             ("account_title__icontains", account_title),
@@ -4870,8 +5021,8 @@ class TangoClient:
             name: Human-readable name for this alert.
             query_type: One of ``opportunity``, ``contract``, ``idv``, ``ota``,
                 ``otidv``, ``entity``, ``grant``, ``forecast``, ``exclusion``,
-                ``dibbs_rfq``, ``dibbs_rfp``, ``sled_opportunity`` or
-                ``contract_appeal``. :meth:`list_webhook_event_types` is the
+                ``dibbs_rfq``, ``dibbs_rfp``, ``sled_opportunity``,
+                ``contract_appeal`` or ``federal_register``. :meth:`list_webhook_event_types` is the
                 current authority — this list can only go stale.
             filters: Dict of query parameters that the alert matches against
                 (e.g. ``{"naics": "541330", "set_aside": "SBA"}``).

{tango_python-1.7.0 → tango_python-1.8.0}/tango/models.py

@@ -1213,6 +1213,65 @@ class ContractAppeal:
     decision_text: str | None = None
 
 
+class FederalRegisterDocument:
+    """Schema definition for FederalRegisterDocument (not used for instances).
+
+    Federal Register documents at ``/api/federal_register/``: rules, proposed rules, notices and presidential documents published since 1994.
+    Shape-on-demand, so every field is optional.
+
+    A document is identified by ``uuid``.
+    ``document_number`` alone is not unique: the Federal Register reused some numbers before 2016, so ``document_number=`` can match more than one document.
+
+    ``agencies``, ``cfr_references``, ``dockets`` and ``topics`` are the Federal Register's own structures, served as published.
+    ``full_text`` can run to several MB, so it is available on the detail endpoint only and only when named in ``shape``.
+    """
+
+    uuid: str | None = None
+    document_number: str | None = None
+    publication_date: date | None = None
+    citation: str | None = None
+    title: str | None = None
+    type: str | None = None
+    subtype: str | None = None
+    abstract: str | None = None
+    action: str | None = None
+    dates: str | None = None
+    comments_close_on: date | None = None
+    effective_on: date | None = None
+    signing_date: date | None = None
+    start_page: int | None = None
+    end_page: int | None = None
+    page_length: int | None = None
+    volume: int | None = None
+    significant: bool | None = None
+    toc_doc: str | None = None
+    toc_subject: str | None = None
+    correction_of: str | None = None
+    corrections: list[str] | None = None
+    disposition_notes: str | None = None
+    executive_order_notes: str | None = None
+    executive_order_number: str | None = None
+    presidential_document_number: str | None = None
+    proclamation_number: str | None = None
+    not_received_for_publication: str | None = None
+    comment_url: str | None = None
+    regulations_dot_gov_url: str | None = None
+    html_url: str | None = None
+    body_html_url: str | None = None
+    pdf_url: str | None = None
+    public_inspection_pdf_url: str | None = None
+    raw_text_url: str | None = None
+    agencies: list[dict[str, Any]] | None = None
+    cfr_references: list[dict[str, Any]] | None = None
+    dockets: list[dict[str, Any]] | None = None
+    docket_ids: list[str] | None = None
+    topics: list[str] | None = None
+    regulation_id_numbers: list[str] | None = None
+    regulation_id_number_info: dict[str, Any] | None = None
+    regulations_dot_gov_info: dict[str, Any] | None = None
+    full_text: str | None = None
+
+
 @dataclass
 class PaginatedResponse[T]:
     """Paginated API response
@@ -1394,6 +1453,24 @@ class ShapeConfig:
         "listing_year,first_listed_at,listed,text_status,text_char_count"
     )
 
+    # Default for list_federal_register_documents(). Mirrors the API's own list default.
+    FEDERAL_REGISTER_MINIMAL: Final = (
+        "uuid,document_number,publication_date,type,subtype,title,abstract,action,"
+        "agencies,cfr_references,citation,significant,comments_close_on,effective_on,"
+        "html_url,pdf_url"
+    )
+
+    # Default for get_federal_register_document(). Mirrors the API's own retrieve default.
+    # `full_text` is left out on purpose: it can run to several MB.
+    FEDERAL_REGISTER_COMPREHENSIVE: Final = (
+        "uuid,document_number,publication_date,type,subtype,title,abstract,action,"
+        "agencies,cfr_references,citation,significant,comments_close_on,effective_on,"
+        "html_url,pdf_url,dates,signing_date,start_page,end_page,volume,docket_ids,"
+        "dockets,regulation_id_numbers,topics,correction_of,corrections,"
+        "executive_order_number,presidential_document_number,proclamation_number,"
+        "comment_url,regulations_dot_gov_url,raw_text_url,body_html_url"
+    )
+
     # Default for list_dibbs_rfqs()
     DIBBS_RFQS_MINIMAL: Final = (
         "uuid,solicitation,nsn,part_number,nomenclature,quantity,issue_date,return_by_date,is_open"

{tango_python-1.7.0 → tango_python-1.8.0}/tango/shapes/explicit_schemas.py

@@ -800,6 +800,83 @@ CONTRACT_APPEAL_SCHEMA: dict[str, FieldSchema] = {
 }
 
 
+FEDERAL_REGISTER_DOCUMENT_SCHEMA: dict[str, FieldSchema] = {
+    "uuid": FieldSchema(name="uuid", type=str, is_optional=True, is_list=False),
+    "document_number": FieldSchema(
+        name="document_number", type=str, is_optional=True, is_list=False
+    ),
+    "publication_date": FieldSchema(
+        name="publication_date", type=date, is_optional=True, is_list=False
+    ),
+    "citation": FieldSchema(name="citation", type=str, is_optional=True, is_list=False),
+    "title": FieldSchema(name="title", type=str, is_optional=True, is_list=False),
+    "type": FieldSchema(name="type", type=str, is_optional=True, is_list=False),
+    "subtype": FieldSchema(name="subtype", type=str, is_optional=True, is_list=False),
+    "abstract": FieldSchema(name="abstract", type=str, is_optional=True, is_list=False),
+    "action": FieldSchema(name="action", type=str, is_optional=True, is_list=False),
+    "dates": FieldSchema(name="dates", type=str, is_optional=True, is_list=False),
+    "comments_close_on": FieldSchema(
+        name="comments_close_on", type=date, is_optional=True, is_list=False
+    ),
+    "effective_on": FieldSchema(name="effective_on", type=date, is_optional=True, is_list=False),
+    "signing_date": FieldSchema(name="signing_date", type=date, is_optional=True, is_list=False),
+    "start_page": FieldSchema(name="start_page", type=int, is_optional=True, is_list=False),
+    "end_page": FieldSchema(name="end_page", type=int, is_optional=True, is_list=False),
+    "page_length": FieldSchema(name="page_length", type=int, is_optional=True, is_list=False),
+    "volume": FieldSchema(name="volume", type=int, is_optional=True, is_list=False),
+    "significant": FieldSchema(name="significant", type=bool, is_optional=True, is_list=False),
+    "toc_doc": FieldSchema(name="toc_doc", type=str, is_optional=True, is_list=False),
+    "toc_subject": FieldSchema(name="toc_subject", type=str, is_optional=True, is_list=False),
+    "correction_of": FieldSchema(name="correction_of", type=str, is_optional=True, is_list=False),
+    "corrections": FieldSchema(name="corrections", type=str, is_optional=True, is_list=True),
+    "disposition_notes": FieldSchema(
+        name="disposition_notes", type=str, is_optional=True, is_list=False
+    ),
+    "executive_order_notes": FieldSchema(
+        name="executive_order_notes", type=str, is_optional=True, is_list=False
+    ),
+    "executive_order_number": FieldSchema(
+        name="executive_order_number", type=str, is_optional=True, is_list=False
+    ),
+    "presidential_document_number": FieldSchema(
+        name="presidential_document_number", type=str, is_optional=True, is_list=False
+    ),
+    "proclamation_number": FieldSchema(
+        name="proclamation_number", type=str, is_optional=True, is_list=False
+    ),
+    "not_received_for_publication": FieldSchema(
+        name="not_received_for_publication", type=str, is_optional=True, is_list=False
+    ),
+    "comment_url": FieldSchema(name="comment_url", type=str, is_optional=True, is_list=False),
+    "regulations_dot_gov_url": FieldSchema(
+        name="regulations_dot_gov_url", type=str, is_optional=True, is_list=False
+    ),
+    "html_url": FieldSchema(name="html_url", type=str, is_optional=True, is_list=False),
+    "body_html_url": FieldSchema(name="body_html_url", type=str, is_optional=True, is_list=False),
+    "pdf_url": FieldSchema(name="pdf_url", type=str, is_optional=True, is_list=False),
+    "public_inspection_pdf_url": FieldSchema(
+        name="public_inspection_pdf_url", type=str, is_optional=True, is_list=False
+    ),
+    "raw_text_url": FieldSchema(name="raw_text_url", type=str, is_optional=True, is_list=False),
+    "agencies": FieldSchema(name="agencies", type=dict, is_optional=True, is_list=True),
+    "cfr_references": FieldSchema(name="cfr_references", type=dict, is_optional=True, is_list=True),
+    "dockets": FieldSchema(name="dockets", type=dict, is_optional=True, is_list=True),
+    "docket_ids": FieldSchema(name="docket_ids", type=str, is_optional=True, is_list=True),
+    "topics": FieldSchema(name="topics", type=str, is_optional=True, is_list=True),
+    "regulation_id_numbers": FieldSchema(
+        name="regulation_id_numbers", type=str, is_optional=True, is_list=True
+    ),
+    "regulation_id_number_info": FieldSchema(
+        name="regulation_id_number_info", type=dict, is_optional=True, is_list=False
+    ),
+    "regulations_dot_gov_info": FieldSchema(
+        name="regulations_dot_gov_info", type=dict, is_optional=True, is_list=False
+    ),
+    # Detail endpoint only, and only when named in the shape.
+    "full_text": FieldSchema(name="full_text", type=str, is_optional=True, is_list=False),
+}
+
+
 AGENCY_SCHEMA: dict[str, FieldSchema] = {
     "abbreviation": FieldSchema(name="abbreviation", type=str, is_optional=True, is_list=False),
     "code": FieldSchema(name="code", type=str, is_optional=False, is_list=False),
@@ -1545,6 +1622,7 @@ EXPLICIT_SCHEMAS: dict[str, dict[str, FieldSchema]] = {
     "Protest": PROTEST_SCHEMA,
     "ProtestDocket": PROTEST_DOCKET_SCHEMA,
     "ContractAppeal": CONTRACT_APPEAL_SCHEMA,
+    "FederalRegisterDocument": FEDERAL_REGISTER_DOCUMENT_SCHEMA,
     "Agency": AGENCY_SCHEMA,
     "Grant": GRANT_SCHEMA,
     # Vehicles (Awards)