pfmsoft-api-request 0.1.3__py3-none-any.whl

pfmsoft_api_request-0.1.3.dist-info/METADATA

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: pfmsoft-api-request
+Version: 0.1.3
+Summary: A command line api request tool with caching and rate limiting.
+Author: Chad Lowe
+Author-email: Chad Lowe <pfmsoft.dev@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: aiolimiter>=1.2.1
+Requires-Dist: httpx2>=2.5.0
+Requires-Dist: pfmsoft-eve-snippets>=0.1.4
+Requires-Dist: pydantic>=2.13.4
+Requires-Dist: pydantic-settings>=2.14.2
+Requires-Dist: typer>=0.26.8
+Requires-Dist: whenever>=0.10.2
+Requires-Python: >=3.14
+Project-URL: Documentation, https://github.com/DonalChilde/pfmsoft-api-request#readme
+Project-URL: Issues, https://github.com/DonalChilde/pfmsoft-api-request/issues
+Project-URL: Source, https://github.com/DonalChilde/pfmsoft-api-request
+Description-Content-Type: text/markdown
+
+# api-request
+
+`api-request` is an API-first Python project for executing batched HTTP requests with:
+
+- async request orchestration
+- optional SQLite-backed caching
+- configurable rate limiting
+- JSON in / JSON out workflows
+
+It includes a simple CLI for running request batches from stdin or files, and a Python API for integrating the same behavior in application code.
+
+## Project Status
+
+- Package manager: `uv`
+- Distribution: source-only for now (no PyPI release yet)
+- Python: `>=3.14`
+
+## Installation
+
+Clone the repository and sync dependencies with `uv`:
+
+```bash
+uv sync
+```
+
+This creates/updates the local `.venv` and installs app + dev dependencies.
+
+## Quick Start (CLI)
+
+Show CLI help:
+
+```bash
+uv run api-request --help
+```
+
+Run a batch from stdin and print plain JSON to stdout:
+
+```bash
+cat requests.json | uv run api-request --from - --to - --plain --indent 2
+```
+
+Run from file and write to file:
+
+```bash
+uv run api-request --from requests.json --to responses.json --overwrite --indent 2
+```
+
+Show version and resolved runtime directories:
+
+```bash
+uv run api-request --version
+```
+
+### Input JSON Shape
+
+The CLI expects a JSON object keyed by request UUID. Each value is a request definition.
+
+Minimal example:
+
+```json
+{
+  "00000000-0000-0000-0000-000000000001": {
+		"url": "https://esi.evetech.net/status/",
+		"method": "GET"
+  }
+}
+```
+
+Supported request fields include:
+
+- `url` (required)
+- `method` (required)
+- `headers` (optional map)
+- `body` (optional)
+- `parameters` (optional query param map)
+- `cache_key` (optional UUID)
+- `rate_key` (optional string)
+
+### Output JSON Shape
+
+The CLI returns a JSON object with:
+
+- `successful`: map of request UUID -> response
+- `failed`: map of request UUID -> failed response
+
+## Python API Usage
+
+```python
+import asyncio
+from uuid import uuid4
+
+from api_request import ApiRequester, Request
+from api_request.cache import InMemoryCache
+from api_request.rate_limit import AiolimiterRateLimiterFactory
+
+
+async def main() -> None:
+    request = Request(
+        request_key=uuid4(),
+        method="GET",
+        url="https://esi.evetech.net/status/",
+        cache_key=uuid4(),
+        rate_key="esi-status",
+    )
+
+    async with ApiRequester(
+        cache_factory=InMemoryCache,
+        rate_limiter_factory=AiolimiterRateLimiterFactory(
+            max_rate=50.0,
+            time_period=60.0,
+        ),
+    ) as requester:
+        responses = await requester.process_requests({request.request_key: request})
+        print(responses)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Configuration
+
+Runtime settings use environment variables with the `API_REQUEST_` prefix.
+
+- `API_REQUEST_APPLICATION_DIRECTORY`: overrides the app directory used for cache and logs.
+
+You can also set this from the CLI with `--application-directory`.
+
+## Development
+
+Common commands:
+
+```bash
+uv sync
+uv run ruff format
+uv run ruff check
+uv run pytest
+```
+
+## Repository Layout
+
+- `src/api_request/`: package source
+- `src/api_request/cli/`: Typer CLI entrypoints
+- `src/api_request/request/`: request orchestration and models
+- `src/api_request/cache/`: cache implementations and protocols
+- `tests/`: test suite
+
+## License
+
+MIT. See `LICENSE`.

pfmsoft_api_request-0.1.3.dist-info/RECORD

@@ -0,0 +1,40 @@
+pfmsoft/api_request/__init__.py,sha256=Opu2pMtL8_PGWBG6rDFR26X54UA5liz1FDsvb1-ZxzE,922
+pfmsoft/api_request/cache/__init__.py,sha256=lp5QuVM9GIP2QGPMV0UeTH4kaH3G8PErFyYFEiQjYvw,1114
+pfmsoft/api_request/cache/memory_cache.py,sha256=cK2AYCKQDUPXcb8MIscQH6Fve1D7lkzk6UvQ3LSucuI,5989
+pfmsoft/api_request/cache/metadata_helpers.py,sha256=vslD4QkY2ABhSdZe83VT5bciUx2zo6jiV3fhV6-GCXI,2093
+pfmsoft/api_request/cache/models.py,sha256=qpxOWbcnzKui3IyHqXBGN-G2DN_eXl8dy9M_z77RpKk,2763
+pfmsoft/api_request/cache/protocols.py,sha256=vuaM8ktqy_tn_mpV5HSCaKDQ6yj4tj-EVCnte8Ib3eg,5798
+pfmsoft/api_request/cache/sqlite_cache/__init__.py,sha256=2zODFz3DZFDs7BssOZ1lTY_8KRmoFJIE7-PLjhwd_7I,308
+pfmsoft/api_request/cache/sqlite_cache/connection_helpers.py,sha256=K9yh0fBRh-cY0Y5crk6JwrKilWN9mz_UnPNXQq5jlqc,4042
+pfmsoft/api_request/cache/sqlite_cache/query_helpers.py,sha256=b09n16j6k4aOVq6evqZT7YUhTIo2yBt2wPuzV4eM6vM,3118
+pfmsoft/api_request/cache/sqlite_cache/sqlite_cache.py,sha256=Pj0S1Lnx93BVb7goqB0zYIuWrpAb2O4ZRGuw7RG2uQQ,8301
+pfmsoft/api_request/cache/sqlite_cache/table_definitions.sql,sha256=aASaqvvEKeFXfi1PmzuBhD_kUXo7uzBP_JZ8eT8kBL4,925
+pfmsoft/api_request/cli/__init__.py,sha256=RsI5_x7mc_YEOxGKJT36ffiByxIL_5orJWrS06ic9yI,487
+pfmsoft/api_request/cli/cache/__init__.py,sha256=D6u1cGn5awj3PlT8kB81mhMtvW6ukxBWu1Uk74yghsU,249
+pfmsoft/api_request/cli/cache/info.py,sha256=bFKa0sCdmA4SKP0-JItrqooAzaFXtQPJmu4yFRGt8V0,210
+pfmsoft/api_request/cli/helpers.py,sha256=2wlriaICKSZObs_cSUikNXCRkxktjK-LewWI5v0l8YI,1249
+pfmsoft/api_request/cli/main_typer.py,sha256=48ecfkO2Wsk7ha-ygudfpTOsqwotxRy3J7HZpha8aqA,1646
+pfmsoft/api_request/cli/request/__init__.py,sha256=RVMXNWh-9bKp9Z0wyWpTG3DYVbQpB0oOCCZN27qBVoo,236
+pfmsoft/api_request/cli/request/request.py,sha256=_PSS-cPCp7eXP-U0hLtYoMedeqxRF-N1tUkpFP1Xtww,6805
+pfmsoft/api_request/cli/request/validate.py,sha256=wYZyeD5WMaA6eV1VwdrK4G6A2ID8qXdIZe553HXjOwA,224
+pfmsoft/api_request/helpers/http_session_factory.py,sha256=81vaOLvzHtYOsA85IVKx5rolXn1SLNz6_5LCZSl-Rck,2296
+pfmsoft/api_request/helpers/json_io.py,sha256=b9GRcZyIrnI_DLJZBfvcV-cCaMhXIAOXpVQOEz-DL6A,8243
+pfmsoft/api_request/helpers/save_text_file.py,sha256=7qMBER_OWB9mtccB8FilxQy3cyrUqNlh5-tJr9tYoxA,1307
+pfmsoft/api_request/helpers/whenever/__init__.py,sha256=xyHFXbilArMhsgOPUqk6EtASY7gKchJNMLHT6pQdAIU,106
+pfmsoft/api_request/helpers/whenever/instant_helpers.py,sha256=mq07gEIm3_iGcyh6eVX5rLl6Ubl9fsk5sHhlXtotiyY,1289
+pfmsoft/api_request/logging_config.py,sha256=OT7F0Ru88yzM2cGwMB-CNILd6JLgVyET16fIjHDLzqs,7709
+pfmsoft/api_request/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pfmsoft/api_request/rate_limit/__init__.py,sha256=7GYbM2505tNLfb2jkU2u7dbXxODtJ81M7NE6XKwYQlU,726
+pfmsoft/api_request/rate_limit/aio_limiter.py,sha256=WTgTy6Koco9Dz8mQxQG0voyWA32PRm3FchHGxErZemc,2707
+pfmsoft/api_request/rate_limit/protocols.py,sha256=1SumbrKYGlr8n46hdSsjAthYxk5Tiw0osuBkILu3OIw,3429
+pfmsoft/api_request/request/__init__.py,sha256=Vl0ykMOAXmXuiQgpihmXHeYfZF9wHZrfCsbEU0LNEvw,441
+pfmsoft/api_request/request/api_requester.py,sha256=kk2aNoI-KKtACULzAwrZfWHOB6fXbtK2k7eW7JMPrto,27122
+pfmsoft/api_request/request/intermediate_models.py,sha256=8AdeTbI-jrXQLZSN2irsgpQ1zrZfG9ZMrYeRIZCkDaw,4457
+pfmsoft/api_request/request/models.py,sha256=DAdUJhgmO_F2geKh-XU6bYhIeRePq-mkzX3BcAJUY54,13421
+pfmsoft/api_request/request/protocols.py,sha256=XIBsxlJ40JsE5W45l3UCHJf2nrfO1HI2wLuq91qlqWA,1534
+pfmsoft/api_request/settings.py,sha256=OARLZrZ2t6rgMhSGONoW0f4gC9bem80UdtUteh5UeBw,2107
+pfmsoft_api_request-0.1.3.dist-info/licenses/LICENSE,sha256=13NS5_XEPeh-i7AW3Hw7MzlU9iZnhazUBaA6hvm-STY,1066
+pfmsoft_api_request-0.1.3.dist-info/WHEEL,sha256=YR4QUxGCbsyoOnWBVTv-p1I4yc3seKGPev46mvmc8Cg,81
+pfmsoft_api_request-0.1.3.dist-info/entry_points.txt,sha256=uiuBq5jF74PHlAaWu5mKp9OXGxbqNnsyABwMgV4EnlQ,72
+pfmsoft_api_request-0.1.3.dist-info/METADATA,sha256=WKXcCFICtmJIZXgJy592lJFJMFN0FdEJXO5IGjsOTbM,4008
+pfmsoft_api_request-0.1.3.dist-info/RECORD,,

pfmsoft_api_request-0.1.3.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.11.29
+Root-Is-Purelib: true
+Tag: py3-none-any

pfmsoft_api_request-0.1.3.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+api-request = pfmsoft.api_request.cli.main_typer:app
+

pfmsoft_api_request-0.1.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chad Lowe
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.