edgarparser-sdk 0.1.0__tar.gz → 0.1.2__tar.gz

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edgarparser-sdk
-Version: 0.1.0
+Version: 0.1.2
 Summary: Python SDK for the hosted EdgarParser SEC filings API
 Project-URL: Homepage, https://www.edgarparser.com
 Project-URL: Documentation, https://docs.edgarparser.com
@@ -23,6 +23,10 @@ Description-Content-Type: text/markdown
 
 Python SDK for the hosted EdgarParser API.
 
+**Status:** Living reference  
+**Current authority:** `packages/edgarparser/src/edgarparser/` (`client.py`, `__init__.py`, `_manifest.py`) and `packages/edgarparser/pyproject.toml`  
+**Last verified:** 2026-07-29
+
 ```bash
 pip install edgarparser-sdk
 ```
@@ -36,9 +40,9 @@ print(client)
 
 ## Status
 
-This package is being implemented in the EdgarParser source repo and is not
-published yet. The current local package exports `EdgarClient`, typed SDK
-errors, and the first v1 hosted-API endpoint methods.
+`edgarparser-sdk` is published on PyPI as the first-party Python client for the
+hosted EdgarParser API. The package exports `EdgarClient`, typed SDK errors,
+and the v1 hosted-API endpoint methods listed below.
 
 ## Package Boundary
 
@@ -71,7 +75,8 @@ from edgarparser import EdgarClient
 client = EdgarClient()
 ```
 
-Use `base_url` for staging or local API testing:
+Default `base_url` is `https://www.edgarparser.com`. Override it for staging
+or local API testing:
 
 ```python
 client = EdgarClient(api_key="edgar_...", base_url="http://127.0.0.1:8000")

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/README.md

@@ -2,6 +2,10 @@
 
 Python SDK for the hosted EdgarParser API.
 
+**Status:** Living reference  
+**Current authority:** `packages/edgarparser/src/edgarparser/` (`client.py`, `__init__.py`, `_manifest.py`) and `packages/edgarparser/pyproject.toml`  
+**Last verified:** 2026-07-29
+
 ```bash
 pip install edgarparser-sdk
 ```
@@ -15,9 +19,9 @@ print(client)
 
 ## Status
 
-This package is being implemented in the EdgarParser source repo and is not
-published yet. The current local package exports `EdgarClient`, typed SDK
-errors, and the first v1 hosted-API endpoint methods.
+`edgarparser-sdk` is published on PyPI as the first-party Python client for the
+hosted EdgarParser API. The package exports `EdgarClient`, typed SDK errors,
+and the v1 hosted-API endpoint methods listed below.
 
 ## Package Boundary
 
@@ -50,7 +54,8 @@ from edgarparser import EdgarClient
 client = EdgarClient()
 ```
 
-Use `base_url` for staging or local API testing:
+Default `base_url` is `https://www.edgarparser.com`. Override it for staging
+or local API testing:
 
 ```python
 client = EdgarClient(api_key="edgar_...", base_url="http://127.0.0.1:8000")

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/pyproject.toml

@@ -33,9 +33,11 @@ dev = [
 path = "src/edgarparser/__init__.py"
 
 [tool.hatch.build.targets.wheel]
+core-metadata-version = "2.4"
 packages = ["src/edgarparser"]
 
 [tool.hatch.build.targets.sdist]
+core-metadata-version = "2.4"
 include = [
     "src/edgarparser/",
     "examples/",

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/src/edgarparser/__init__.py

@@ -27,4 +27,4 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.1.0"
+__version__ = "0.1.2"

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/src/edgarparser/_manifest.py

@@ -12,7 +12,6 @@ class SDKMethodSpec:
     api_method: str
     api_path: str
     contract_version: str
-    schema_fingerprint: str
     required_params: tuple[str, ...] = ()
     optional_params: tuple[str, ...] = ()
     path_params: tuple[str, ...] = ()
@@ -25,8 +24,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="get_financials",
         api_method="GET",
         api_path="/api/financials",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:8c2b5486165eb2628dfb324c558c1148a48a46453f4102f0491e16503316b1c5",
+        contract_version="2.0.0",
         required_params=("ticker", "year", "quarter"),
         optional_params=("full_year_mode", "source"),
     ),
@@ -35,8 +33,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="get_metric",
         api_method="GET",
         api_path="/api/metric",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:0350ec893a5d3a2a2510dc059711a93f6ec9665a0e068b32d8c4b2d8cb8accd8",
+        contract_version="2.0.0",
         required_params=("ticker", "year", "quarter", "metric_name"),
         optional_params=("full_year_mode", "source", "date_type", "role"),
     ),
@@ -45,8 +42,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="get_metric_series",
         api_method="GET",
         api_path="/api/metric/series",
-        contract_version="1.1.0",
-        schema_fingerprint="sha256:dff62ae8bf4eb8c648776ac91e02e324c83a1cccbf3beeefcb7855272970a906",
+        contract_version="2.0.0",
         required_params=("ticker", "metric_name", "end_year", "end_quarter"),
         optional_params=(
             "periods",
@@ -64,8 +60,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="list_metrics",
         api_method="GET",
         api_path="/api/financials/list_metrics",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:07341bd265a257b8c90ee99b42ecef054e6eaa16c2f341f91ffae287bfe907d8",
+        contract_version="1.1.0",
         required_params=("ticker", "year", "quarter"),
         optional_params=(
             "full_year_mode",
@@ -80,8 +75,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="search_metrics",
         api_method="GET",
         api_path="/api/financials/search_metrics",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:381c0bf743038780d55c447b0c7103da0e22d13c33b866c73130b7265071853c",
+        contract_version="1.1.0",
         required_params=("ticker", "year", "quarter", "query"),
         optional_params=(
             "full_year_mode",
@@ -97,8 +91,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="get_statement",
         api_method="GET",
         api_path="/api/statement",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:6da91e176e78fe536130ed3ea11cf9b8dfccf923cbbfc47483d7cb2108383986",
+        contract_version="2.0.0",
         required_params=("ticker", "statement"),
         optional_params=(
             "year",
@@ -116,7 +109,6 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         api_method="GET",
         api_path="/api/filings",
         contract_version="1.0.0",
-        schema_fingerprint="sha256:ffa7e669b836cbbc181bc337cb55219e55bf9a5c75ce3d27040a8aad25f8c993",
         required_params=("ticker", "year", "quarter"),
         optional_params=("source",),
     ),
@@ -125,8 +117,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="get_filing_document",
         api_method="GET",
         api_path="/api/filing/document",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:4d559aded5c9760ccb498944a984a128254a76349348de297da30ee338ff123a",
+        contract_version="1.1.0",
         optional_params=(
             "ticker",
             "year",
@@ -147,8 +138,7 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         tool_name="search_filing_text",
         api_method="GET",
         api_path="/api/filing/text/search",
-        contract_version="1.0.0",
-        schema_fingerprint="sha256:be08198a156e55118e9b32a0fb41ead07906469059fb27d3010f1a1f5a9c0c8c",
+        contract_version="1.1.0",
         required_params=("ticker", "year", "quarter", "query"),
         optional_params=("source",),
     ),
@@ -158,7 +148,6 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         api_method="POST",
         api_path="/api/warm",
         contract_version="1.0.0",
-        schema_fingerprint="sha256:1636aba36d166ecf2901e72078fc8a6182f7174e541d9183561392781e8f8cbd",
         body_params=("items",),
     ),
     SDKMethodSpec(
@@ -167,7 +156,6 @@ SDK_METHODS: tuple[SDKMethodSpec, ...] = (
         api_method="GET",
         api_path="/api/warm/{job_id}",
         contract_version="1.0.0",
-        schema_fingerprint="sha256:f48e0b9a707e404c640822af06d51f3523f54538fed625a24ee06dc220cb3245",
         path_params=("job_id",),
     ),
 )

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/src/edgarparser/client.py

@@ -468,17 +468,6 @@ class EdgarClient:
             ")"
         )
 
-    def _debug_state(self) -> dict[str, Any]:
-        """Return non-secret state for tests and diagnostics."""
-
-        return {
-            "base_url": self.base_url,
-            "timeout": self.timeout,
-            "api_key_set": bool(self.api_key),
-            "closed": self._closed,
-            "user_agent": self.user_agent,
-        }
-
     def _url(self, path: str) -> str:
         if not path or not path.strip():
             raise ValueError("path must be a non-empty API path")
@@ -555,7 +544,7 @@ class EdgarClient:
     ) -> EdgarAPIError:
         payload = self._response_json(response)
         message = f"HTTP {response.status_code}"
-        error_type: str | None = self._default_error_type(response.status_code)
+        error_cls, error_type = self._error_classification(response.status_code)
         details: Any | None = None
 
         if isinstance(payload, Mapping):
@@ -575,7 +564,6 @@ class EdgarClient:
                 message = text[:300]
                 details = self._text_details(text)
 
-        error_cls = self._error_class(response.status_code)
         return error_cls(
             response.status_code,
             message,
@@ -604,27 +592,18 @@ class EdgarClient:
             return {**details, "cta": payload["cta"]}
         return {"details": details, "cta": payload["cta"]}
 
-    def _default_error_type(self, status_code: int) -> str | None:
-        if status_code == 429:
-            return "rate_limit"
-        if status_code in {400, 422}:
-            return "validation_error"
-        if status_code in {401, 403}:
-            return "auth_error"
-        if status_code == 404:
-            return "not_found"
-        return None
-
-    def _error_class(self, status_code: int) -> type[EdgarAPIError]:
+    def _error_classification(
+        self, status_code: int
+    ) -> tuple[type[EdgarAPIError], str | None]:
         if status_code in {401, 403}:
-            return EdgarAuthError
+            return EdgarAuthError, "auth_error"
         if status_code == 429:
-            return EdgarRateLimitError
+            return EdgarRateLimitError, "rate_limit"
         if status_code == 404:
-            return EdgarNotFoundError
+            return EdgarNotFoundError, "not_found"
         if status_code in {400, 422}:
-            return EdgarValidationError
-        return EdgarAPIError
+            return EdgarValidationError, "validation_error"
+        return EdgarAPIError, None
 
     def _text_details(self, text: str) -> dict[str, str] | None:
         if not text:

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/tests/test_client.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 import pytest
 
-from edgarparser import DEFAULT_BASE_URL, DEFAULT_TIMEOUT, EdgarClient
+from edgarparser import DEFAULT_BASE_URL, DEFAULT_TIMEOUT, EdgarClient, EdgarError
 
 
 class RecordingSession:
@@ -20,7 +20,7 @@ def test_client_defaults(monkeypatch: pytest.MonkeyPatch) -> None:
 
     assert client.base_url == DEFAULT_BASE_URL
     assert client.timeout == DEFAULT_TIMEOUT
-    assert client.headers() == {"User-Agent": "edgarparser-sdk/0.1.0"}
+    assert client.headers() == {"User-Agent": "edgarparser-sdk/0.1.2"}
     assert "api_key=<unset>" in repr(client)
 
 
@@ -56,13 +56,11 @@ def test_client_validates_base_url_and_timeout() -> None:
         EdgarClient(timeout=0)
 
 
-def test_client_closes_owned_session() -> None:
+def test_client_close_is_idempotent() -> None:
     client = EdgarClient(api_key="x")
     client.close()
     client.close()
 
-    assert client._debug_state()["closed"] is True
-
 
 def test_client_does_not_close_injected_session() -> None:
     session = RecordingSession()
@@ -71,11 +69,11 @@ def test_client_does_not_close_injected_session() -> None:
     client.close()
 
     assert session.closed is False
-    assert client._debug_state()["closed"] is True
 
 
-def test_context_manager_closes_owned_session() -> None:
+def test_context_manager_rejects_requests_after_exit() -> None:
     with EdgarClient(api_key="x") as client:
-        assert client._debug_state()["closed"] is False
+        pass
 
-    assert client._debug_state()["closed"] is True
+    with pytest.raises(EdgarError, match="client is closed"):
+        client.get_financials("AAPL", year=2025, quarter=1)

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/tests/test_import.py

@@ -5,7 +5,7 @@ def test_import_exports_client_and_version() -> None:
     import edgarparser
     from edgarparser import EdgarAPIError, EdgarClient, EdgarError
 
-    assert edgarparser.__version__ == "0.1.0"
+    assert edgarparser.__version__ == "0.1.2"
     assert EdgarClient.__name__ == "EdgarClient"
     assert EdgarError.__name__ == "EdgarError"
     assert issubclass(EdgarAPIError, EdgarError)

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/tests/test_manifest_alignment.py

@@ -93,7 +93,6 @@ def test_sdk_manifest_matches_tool_manifest_contracts() -> None:
         assert tool["api_method"] == spec.api_method
         assert tool["api_path"] == spec.api_path
         assert tool["contract_version"] == spec.contract_version
-        assert tool["schema_fingerprint"] == spec.schema_fingerprint
 
 
 def test_sdk_manifest_matches_fastapi_route_contracts() -> None:

edgarparser_sdk-0.1.2/tests/test_packaging.py

@@ -0,0 +1,71 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+import tarfile
+import zipfile
+from pathlib import Path
+
+import tomllib
+
+PACKAGE_ROOT = Path(__file__).resolve().parents[1]
+
+
+def test_pyproject_uses_package_version_as_source_of_truth() -> None:
+    pyproject = tomllib.loads((PACKAGE_ROOT / "pyproject.toml").read_text())
+
+    assert pyproject["project"]["name"] == "edgarparser-sdk"
+    assert pyproject["project"]["dynamic"] == ["version"]
+    assert pyproject["tool"]["hatch"]["version"]["path"] == (
+        "src/edgarparser/__init__.py"
+    )
+    assert pyproject["tool"]["hatch"]["build"]["targets"]["wheel"][
+        "core-metadata-version"
+    ] == "2.4"
+    assert pyproject["tool"]["hatch"]["build"]["targets"]["sdist"][
+        "core-metadata-version"
+    ] == "2.4"
+
+
+def test_distributions_use_compatible_metadata_and_wheel_contents(
+    tmp_path: Path,
+) -> None:
+    subprocess.run(
+        [
+            sys.executable,
+            "-m",
+            "build",
+            "--outdir",
+            str(tmp_path),
+            str(PACKAGE_ROOT),
+        ],
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+
+    wheel = next(tmp_path.glob("edgarparser_sdk-*.whl"))
+    with zipfile.ZipFile(wheel) as archive:
+        names = set(archive.namelist())
+        metadata_name = next(
+            name for name in names if name.endswith(".dist-info/METADATA")
+        )
+        metadata = archive.read(metadata_name)
+
+    assert metadata.splitlines()[0] == b"Metadata-Version: 2.4"
+    assert "edgarparser/py.typed" in names
+    assert any(name.endswith(".dist-info/licenses/LICENSE") for name in names)
+
+    sdist = next(tmp_path.glob("edgarparser_sdk-*.tar.gz"))
+    with tarfile.open(sdist, "r:gz") as archive:
+        pkg_info_member = next(
+            member
+            for member in archive.getmembers()
+            if member.name.endswith("/PKG-INFO")
+            and len(Path(member.name).parts) == 2
+        )
+        pkg_info_file = archive.extractfile(pkg_info_member)
+        assert pkg_info_file is not None
+        pkg_info = pkg_info_file.read()
+
+    assert pkg_info.splitlines()[0] == b"Metadata-Version: 2.4"

{edgarparser_sdk-0.1.0 → edgarparser_sdk-0.1.2}/tests/test_request_core.py

@@ -86,7 +86,7 @@ def test_request_builds_url_headers_params_body_and_timeout() -> None:
             "method": "GET",
             "url": "https://api.example.com/api/test",
             "headers": {
-                "User-Agent": "edgarparser-sdk/0.1.0",
+                "User-Agent": "edgarparser-sdk/0.1.2",
                 "Authorization": "Bearer secret-key",
             },
             "params": {"ticker": "AAPL"},

edgarparser_sdk-0.1.0/tests/test_packaging.py

@@ -1,44 +0,0 @@
-from __future__ import annotations
-
-import subprocess
-import sys
-import zipfile
-from pathlib import Path
-
-import tomllib
-
-PACKAGE_ROOT = Path(__file__).resolve().parents[1]
-
-
-def test_pyproject_uses_package_version_as_source_of_truth() -> None:
-    pyproject = tomllib.loads((PACKAGE_ROOT / "pyproject.toml").read_text())
-
-    assert pyproject["project"]["name"] == "edgarparser-sdk"
-    assert pyproject["project"]["dynamic"] == ["version"]
-    assert pyproject["tool"]["hatch"]["version"]["path"] == (
-        "src/edgarparser/__init__.py"
-    )
-
-
-def test_wheel_contains_typed_marker_and_license(tmp_path: Path) -> None:
-    subprocess.run(
-        [
-            sys.executable,
-            "-m",
-            "build",
-            "--wheel",
-            "--outdir",
-            str(tmp_path),
-            str(PACKAGE_ROOT),
-        ],
-        check=True,
-        capture_output=True,
-        text=True,
-    )
-
-    wheel = next(tmp_path.glob("edgarparser_sdk-*.whl"))
-    with zipfile.ZipFile(wheel) as archive:
-        names = set(archive.namelist())
-
-    assert "edgarparser/py.typed" in names
-    assert any(name.endswith(".dist-info/licenses/LICENSE") for name in names)