fulcrumpro 0.1.0__tar.gz

fulcrumpro-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: fulcrumpro
+Version: 0.1.0
+Summary: A lightweight Python SDK for the Fulcrum Pro API, built with `httpx`.
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+
+# FulcrumPro
+
+A lightweight Python SDK for the [Fulcrum Pro](https://fulcrumpro.com) API, built on [`httpx`](https://www.python-httpx.org/).
+
+## Installation
+
+```bash
+pip install fulcrumpro
+```
+
+Or with `uv`:
+
+```bash
+uv add fulcrumpro
+```
+
+## Requirements
+
+- Python 3.14+
+
+## Quick Start
+
+```python
+from fulcrumpro import FulcrumPro
+
+client = FulcrumPro(api_token="your-api-token")
+
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+print(job["name"])
+```
+
+Use as a context manager to ensure the underlying HTTP connection is closed:
+
+```python
+with FulcrumPro(api_token="your-api-token") as client:
+    job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Authentication
+
+All requests are authenticated with a Bearer token. Pass your API token when constructing the client:
+
+```python
+client = FulcrumPro(api_token="your-api-token")
+```
+
+## Resources
+
+### Jobs
+
+```python
+# Get a job by ID
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Error Handling
+
+All non-2xx responses raise a `FulcrumProError`:
+
+```python
+from fulcrumpro import FulcrumPro, FulcrumProError
+
+client = FulcrumPro(api_token="your-api-token")
+
+try:
+    job = client.jobs.get("nonexistent-id")
+except FulcrumProError as e:
+    print(e.status_code)  # e.g. 404
+    print(str(e))         # "FulcrumPro API error 404: not found"
+```
+
+## Version History
+
+See [CHANGELOG.md](CHANGELOG.md).

fulcrumpro-0.1.0/README.md

@@ -0,0 +1,74 @@
+# FulcrumPro
+
+A lightweight Python SDK for the [Fulcrum Pro](https://fulcrumpro.com) API, built on [`httpx`](https://www.python-httpx.org/).
+
+## Installation
+
+```bash
+pip install fulcrumpro
+```
+
+Or with `uv`:
+
+```bash
+uv add fulcrumpro
+```
+
+## Requirements
+
+- Python 3.14+
+
+## Quick Start
+
+```python
+from fulcrumpro import FulcrumPro
+
+client = FulcrumPro(api_token="your-api-token")
+
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+print(job["name"])
+```
+
+Use as a context manager to ensure the underlying HTTP connection is closed:
+
+```python
+with FulcrumPro(api_token="your-api-token") as client:
+    job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Authentication
+
+All requests are authenticated with a Bearer token. Pass your API token when constructing the client:
+
+```python
+client = FulcrumPro(api_token="your-api-token")
+```
+
+## Resources
+
+### Jobs
+
+```python
+# Get a job by ID
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Error Handling
+
+All non-2xx responses raise a `FulcrumProError`:
+
+```python
+from fulcrumpro import FulcrumPro, FulcrumProError
+
+client = FulcrumPro(api_token="your-api-token")
+
+try:
+    job = client.jobs.get("nonexistent-id")
+except FulcrumProError as e:
+    print(e.status_code)  # e.g. 404
+    print(str(e))         # "FulcrumPro API error 404: not found"
+```
+
+## Version History
+
+See [CHANGELOG.md](CHANGELOG.md).

fulcrumpro-0.1.0/fulcrumpro/__init__.py

@@ -0,0 +1,3 @@
+from fulcrumpro.client import FulcrumPro, FulcrumProError
+
+__all__ = ["FulcrumPro", "FulcrumProError"]

fulcrumpro-0.1.0/fulcrumpro/client.py

@@ -0,0 +1,54 @@
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from fulcrumpro.endpoints.jobs import Jobs
+
+
+class FulcrumProError(Exception):
+    def __init__(self, status_code: int, message: str):
+        self.status_code = status_code
+        super().__init__(f"FulcrumPro API error {status_code}: {message}")
+
+
+class FulcrumPro:
+    def __init__(
+        self,
+        api_token: str,
+    ):
+        base_url = "https://api.fulcrumpro.com/api"
+        self._client = httpx.Client(
+            base_url=base_url,
+            headers={
+                "Content-Type": "application/json",
+                "Authorization": f"Bearer {api_token}",
+            },
+        )
+        self.jobs = Jobs(self)
+
+    def _request(self, method: str, path: str, **kwargs: Any) -> dict:
+        response = self._client.request(method, path, **kwargs)
+        if not response.is_success:
+            data = response.json()
+            raise FulcrumProError(response.status_code, data.get("errors"))
+        return response.json()
+
+    def get(self, path: str, **kwargs: Any) -> dict:
+        return self._request("GET", path, **kwargs)
+
+    def post(self, path: str, **kwargs: Any) -> dict:
+        return self._request("POST", path, **kwargs)
+
+    def patch(self, path: str, **kwargs: Any) -> dict:
+        return self._request("PATCH", path, **kwargs)
+
+    def delete(self, path: str, **kwargs: Any) -> dict:
+        return self._request("DELETE", path, **kwargs)
+
+    def __enter__(self) -> FulcrumPro:
+        return self
+
+    def __exit__(self, *_: Any) -> None:
+        self._client.close()

fulcrumpro-0.1.0/fulcrumpro/endpoints/jobs.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+if TYPE_CHECKING:
+    from fulcrumpro.client import FulcrumPro
+
+
+class Jobs:
+    def __init__(self, client: FulcrumPro):
+        self._client = client
+
+    def get(self, job_id: str) -> dict[str, Any]:
+        """
+        Get a job by ID.
+
+        :param job_id: The ID of the job.
+
+        :return: The job data.
+        """
+        return self._client.get(f"/jobs/{job_id}")

fulcrumpro-0.1.0/fulcrumpro.egg-info/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: fulcrumpro
+Version: 0.1.0
+Summary: A lightweight Python SDK for the Fulcrum Pro API, built with `httpx`.
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+Requires-Dist: httpx>=0.28.1
+
+# FulcrumPro
+
+A lightweight Python SDK for the [Fulcrum Pro](https://fulcrumpro.com) API, built on [`httpx`](https://www.python-httpx.org/).
+
+## Installation
+
+```bash
+pip install fulcrumpro
+```
+
+Or with `uv`:
+
+```bash
+uv add fulcrumpro
+```
+
+## Requirements
+
+- Python 3.14+
+
+## Quick Start
+
+```python
+from fulcrumpro import FulcrumPro
+
+client = FulcrumPro(api_token="your-api-token")
+
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+print(job["name"])
+```
+
+Use as a context manager to ensure the underlying HTTP connection is closed:
+
+```python
+with FulcrumPro(api_token="your-api-token") as client:
+    job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Authentication
+
+All requests are authenticated with a Bearer token. Pass your API token when constructing the client:
+
+```python
+client = FulcrumPro(api_token="your-api-token")
+```
+
+## Resources
+
+### Jobs
+
+```python
+# Get a job by ID
+job = client.jobs.get("6a0e5cad7c2e97225f8def9c")
+```
+
+## Error Handling
+
+All non-2xx responses raise a `FulcrumProError`:
+
+```python
+from fulcrumpro import FulcrumPro, FulcrumProError
+
+client = FulcrumPro(api_token="your-api-token")
+
+try:
+    job = client.jobs.get("nonexistent-id")
+except FulcrumProError as e:
+    print(e.status_code)  # e.g. 404
+    print(str(e))         # "FulcrumPro API error 404: not found"
+```
+
+## Version History
+
+See [CHANGELOG.md](CHANGELOG.md).

fulcrumpro-0.1.0/fulcrumpro.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+pyproject.toml
+fulcrumpro/__init__.py
+fulcrumpro/client.py
+fulcrumpro.egg-info/PKG-INFO
+fulcrumpro.egg-info/SOURCES.txt
+fulcrumpro.egg-info/dependency_links.txt
+fulcrumpro.egg-info/requires.txt
+fulcrumpro.egg-info/top_level.txt
+fulcrumpro/endpoints/__init__.py
+fulcrumpro/endpoints/jobs.py
+tests/test_client.py

fulcrumpro-0.1.0/fulcrumpro.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

fulcrumpro-0.1.0/fulcrumpro.egg-info/requires.txt

@@ -0,0 +1 @@
+httpx>=0.28.1

fulcrumpro-0.1.0/fulcrumpro.egg-info/top_level.txt

@@ -0,0 +1 @@
+fulcrumpro

fulcrumpro-0.1.0/pyproject.toml

@@ -0,0 +1,64 @@
+[project]
+name = "fulcrumpro"
+version = "0.1.0"
+description = "A lightweight Python SDK for the Fulcrum Pro API, built with `httpx`."
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "httpx>=0.28.1",
+]
+
+[dependency-groups]
+dev = [
+    "pytest>=9.0.3",
+    "pytest-cov>=7.1.0",
+    "rich>=15.0.0",
+    "ruff>=0.15.14",
+]
+
+[tool.ruff]
+line-length = 88
+target-version = "py312"
+src = ["infra"]
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes — unused imports, undefined names
+    "I",      # isort — import ordering
+    "B",      # flake8-bugbear — common bugs and design issues
+    "C4",     # flake8-comprehensions — better list/dict/set comprehensions
+    "UP",     # pyupgrade — modernize Python syntax
+    "SIM",    # flake8-simplify — simplifiable code
+    "TCH",    # flake8-type-checking — type hint import hygiene
+    "RUF",    # ruff-specific rules
+    "N",      # pep8-naming conventions
+    "S",      # flake8-bandit — security issues
+]
+
+ignore = [
+    "S101",   # assert statements — needed for pytest
+    "B008",   # function calls in default arguments — CDK uses this pattern
+    "N802",   # function name lowercase — CDK construct names are PascalCase
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "S101",   # assert is fine in tests
+    "S105",   # hardcoded passwords fine in tests
+    "S106",
+]
+"cdk/**" = [
+    "N803",   # CDK uses PascalCase for some args
+]
+
+[tool.ruff.lint.isort]
+force-sort-within-sections = true
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.pytest.ini_options]
+pythonpath = ["."]

fulcrumpro-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fulcrumpro-0.1.0/tests/test_client.py

@@ -0,0 +1,103 @@
+from __future__ import annotations
+
+from fulcrumpro.client import FulcrumPro, FulcrumProError
+import pytest
+
+from .conftest import make_response
+
+
+class TestInit:
+    def test_sets_auth_header(self, client: FulcrumPro):
+        headers = dict(client._client.headers)
+        assert headers["authorization"] == "Bearer test-token"
+
+    def test_sets_content_type_header(self, client: FulcrumPro):
+        headers = dict(client._client.headers)
+        assert headers["content-type"] == "application/json"
+
+    def test_exposes_jobs_resource(self, client: FulcrumPro):
+        from fulcrumpro.endpoints.jobs import Jobs
+
+        assert isinstance(client.jobs, Jobs)
+
+
+class TestRequest:
+    def test_returns_parsed_json_on_success(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {"id": "abc"})
+        result = client._request("GET", "/jobs/abc")
+        assert result == {"id": "abc"}
+
+    def test_calls_underlying_client_with_method_and_path(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {})
+        client._request("GET", "/jobs/abc")
+        client._client.request.assert_called_once_with("GET", "/jobs/abc")
+
+    def test_raises_fulcrumpro_error_on_4xx(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(
+            404, {"errors": "not found"}
+        )
+        with pytest.raises(FulcrumProError) as exc_info:
+            client._request("GET", "/jobs/missing")
+        assert exc_info.value.status_code == 404
+        assert "not found" in str(exc_info.value)
+
+    def test_raises_fulcrumpro_error_on_5xx(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(500, {"errors": "boom"})
+        with pytest.raises(FulcrumProError) as exc_info:
+            client._request("GET", "/jobs/abc")
+        assert exc_info.value.status_code == 500
+
+    def test_propagates_json_decode_error_on_non_json_response(
+        self, client: FulcrumPro
+    ):
+        from json import JSONDecodeError
+
+        client._client.request.return_value = make_response(502, text="Bad Gateway")
+        with pytest.raises(JSONDecodeError):
+            client._request("GET", "/jobs/abc")
+
+    def test_passes_extra_kwargs_to_underlying_client(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {})
+        client._request("POST", "/jobs", json={"name": "test"})
+        client._client.request.assert_called_once_with(
+            "POST", "/jobs", json={"name": "test"}
+        )
+
+
+class TestHttpMethods:
+    def test_get_delegates_to_request(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {"ok": True})
+        result = client.get("/jobs/1")
+        client._client.request.assert_called_once_with("GET", "/jobs/1")
+        assert result == {"ok": True}
+
+    def test_post_delegates_to_request(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(201, {"id": "new"})
+        result = client.post("/jobs", json={"name": "new job"})
+        client._client.request.assert_called_once_with(
+            "POST", "/jobs", json={"name": "new job"}
+        )
+        assert result == {"id": "new"}
+
+    def test_patch_delegates_to_request(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {"id": "1"})
+        result = client.patch("/jobs/1", json={"name": "updated"})
+        client._client.request.assert_called_once_with(
+            "PATCH", "/jobs/1", json={"name": "updated"}
+        )
+        assert result == {"id": "1"}
+
+    def test_delete_delegates_to_request(self, client: FulcrumPro):
+        client._client.request.return_value = make_response(200, {})
+        result = client.delete("/jobs/1")
+        client._client.request.assert_called_once_with("DELETE", "/jobs/1")
+        assert result == {}
+
+
+class TestContextManager:
+    def test_enter_returns_client(self, client: FulcrumPro):
+        assert client.__enter__() is client
+
+    def test_exit_closes_underlying_httpx_client(self, client: FulcrumPro):
+        client.__exit__(None, None, None)
+        client._client.close.assert_called_once()