pyth-hermes 0.1.0__tar.gz

pyth_hermes-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  # Static checks run once on a single modern interpreter. mypy targets 3.10
+  # (its config floor); ruff is interpreter-independent.
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Ruff
+        run: ruff check .
+      - name: Mypy (strict)
+        run: mypy
+
+  # Runtime tests run on every supported interpreter, including 3.9, to verify
+  # true 3.9 compatibility (requires-python >= 3.9).
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[dev]"
+      - name: Pytest
+        run: pytest -q

pyth_hermes-0.1.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

pyth_hermes-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robert Ruben
+
+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.

pyth_hermes-0.1.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: pyth-hermes
+Version: 0.1.0
+Summary: Python client for the Pyth Network Hermes price-oracle API (sync + async, SSE streaming).
+Project-URL: Homepage, https://github.com/robertruben98/pyth-hermes
+Project-URL: Repository, https://github.com/robertruben98/pyth-hermes
+Project-URL: Documentation, https://docs.pyth.network/price-feeds/core/how-pyth-works/hermes
+Project-URL: Issues, https://github.com/robertruben98/pyth-hermes/issues
+Author: Robert Ruben
+License: MIT
+License-File: LICENSE
+Keywords: defi,hermes,oracle,price-feed,pyth,solana
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx-sse>=0.4
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.6
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pandas-stubs; extra == 'dev'
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: pandas
+Requires-Dist: pandas>=2.0; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# pyth-hermes
+
+A typed Python client for the [Pyth Network](https://pyth.network) **Hermes** price-oracle API. Sync **and** async clients, Pydantic v2 models, Server-Sent-Events price streaming with auto-reconnect, and a `Decimal` price helper.
+
+- Sync (`HermesClient`) and async (`AsyncHermesClient`) APIs over `httpx`
+- SSE streaming with reconnect + backoff
+- Graceful 429 rate-limit handling (retries that respect the 60s window)
+- Configurable `base_url` (production, beta, or paid providers) and optional API key from day one
+- `mypy --strict` clean, fully type-hinted, ships `py.typed`
+
+## Install
+
+```bash
+pip install pyth-hermes
+# with the optional pandas helper:
+pip install "pyth-hermes[pandas]"
+```
+
+## Quickstart — BTC/USD price in under 5 lines
+
+```python
+from pyth_hermes import HermesClient
+
+client = HermesClient()
+feed_id = client.get_feed_id("Crypto.BTC/USD")   # exact-symbol lookup
+print(client.get_price_decimal(feed_id))         # -> Decimal("63952.82...")
+```
+
+### Async + streaming
+
+```python
+import asyncio
+from pyth_hermes import AsyncHermesClient
+
+BTC = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+
+async def main():
+    async with AsyncHermesClient() as client:
+        async for update in client.stream_prices([BTC]):
+            print(update.parsed[0].to_decimal())
+
+asyncio.run(main())
+```
+
+### Historical price
+
+```python
+resp = client.get_price_at(1718900000, [BTC])   # unix timestamp
+print(resp.parsed[0].to_decimal())
+```
+
+### pandas
+
+```python
+from pyth_hermes.pandas import updates_to_dataframe
+df = updates_to_dataframe([client.get_latest_price([BTC])])
+```
+
+## Prices and exponents
+
+Pyth returns integer prices plus an exponent. The real value is `price * 10**expo`, computed exactly as a `Decimal`:
+
+```python
+from pyth_hermes import price_to_decimal
+price_to_decimal(6395282153102, -8)   # Decimal("63952.82153102")
+```
+
+`RpcPrice.to_decimal()` and `ParsedPriceUpdate.to_decimal()` are convenience wrappers.
+
+## Finding feed ids — use the EXACT symbol
+
+`/v2/price_feeds?query=btc` returns **deprecated / variant** feeds (e.g. `MBTC`, `XBTC`) *before* the canonical one and matches substrings. `get_feed_id()` therefore matches on exact `attributes.symbol`:
+
+```python
+client.get_feed_id("Crypto.BTC/USD")
+# -> "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+```
+
+## 🔴 Authentication (changes 2026-07-31)
+
+Today the public endpoint needs **no** API key. **From 2026-07-31 an API key becomes mandatory.** This client accepts one from day one — pass it now to be ready:
+
+```python
+client = HermesClient(api_key="YOUR_KEY")  # default: Authorization: Bearer YOUR_KEY
+```
+
+The exact header is not finalized publicly, so both the header name and scheme are configurable:
+
+```python
+HermesClient(api_key="KEY", api_key_header="X-Api-Key", api_key_scheme="")  # -> X-Api-Key: KEY
+```
+
+## Endpoints / base URLs
+
+```python
+from pyth_hermes import HermesClient
+
+HermesClient()                                           # production: https://hermes.pyth.network
+HermesClient(base_url="https://hermes-beta.pyth.network")  # beta
+HermesClient(base_url="https://your-paid-provider.example")  # Triton / P2P / extrnode / Liquify
+```
+
+You may also inject your own preconfigured `httpx.Client` / `httpx.AsyncClient` via `client=...` (e.g. for custom transports, proxies, or connection pools). In that case the request host is taken from **your** client, so set `base_url` on the client itself — passing both `base_url=` and `client=` raises a `UserWarning` because the constructor's `base_url` would be a no-op. The `api_key` is still applied per-request, so it works with an injected client.
+
+```python
+import httpx
+from pyth_hermes import HermesClient
+
+http = httpx.Client(base_url="https://your-paid-provider.example", proxy="http://localhost:8080")
+client = HermesClient(api_key="KEY", client=http)  # base_url comes from `http`
+```
+
+## Rate limits
+
+The public endpoint allows **10 requests / 10 seconds per IP**. Exceeding it returns HTTP 429 for the next 60 seconds. The client retries 429 and 5xx responses with exponential backoff + jitter, honoring any `Retry-After` header and never exceeding the 60s rate-limit window per delay. Tune via `max_retries`, `backoff_base`, `backoff_cap`.
+
+## Not implemented
+
+The TWAP endpoints (`/v2/updates/twap/...`) are intentionally omitted — the API returns HTTP 400 "deprecated and no longer available".
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                 # unit tests (no network)
+pytest -m integration  # live smoke tests against production
+mypy
+ruff check .
+```
+
+## License
+
+MIT

pyth_hermes-0.1.0/README.md

@@ -0,0 +1,133 @@
+# pyth-hermes
+
+A typed Python client for the [Pyth Network](https://pyth.network) **Hermes** price-oracle API. Sync **and** async clients, Pydantic v2 models, Server-Sent-Events price streaming with auto-reconnect, and a `Decimal` price helper.
+
+- Sync (`HermesClient`) and async (`AsyncHermesClient`) APIs over `httpx`
+- SSE streaming with reconnect + backoff
+- Graceful 429 rate-limit handling (retries that respect the 60s window)
+- Configurable `base_url` (production, beta, or paid providers) and optional API key from day one
+- `mypy --strict` clean, fully type-hinted, ships `py.typed`
+
+## Install
+
+```bash
+pip install pyth-hermes
+# with the optional pandas helper:
+pip install "pyth-hermes[pandas]"
+```
+
+## Quickstart — BTC/USD price in under 5 lines
+
+```python
+from pyth_hermes import HermesClient
+
+client = HermesClient()
+feed_id = client.get_feed_id("Crypto.BTC/USD")   # exact-symbol lookup
+print(client.get_price_decimal(feed_id))         # -> Decimal("63952.82...")
+```
+
+### Async + streaming
+
+```python
+import asyncio
+from pyth_hermes import AsyncHermesClient
+
+BTC = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+
+async def main():
+    async with AsyncHermesClient() as client:
+        async for update in client.stream_prices([BTC]):
+            print(update.parsed[0].to_decimal())
+
+asyncio.run(main())
+```
+
+### Historical price
+
+```python
+resp = client.get_price_at(1718900000, [BTC])   # unix timestamp
+print(resp.parsed[0].to_decimal())
+```
+
+### pandas
+
+```python
+from pyth_hermes.pandas import updates_to_dataframe
+df = updates_to_dataframe([client.get_latest_price([BTC])])
+```
+
+## Prices and exponents
+
+Pyth returns integer prices plus an exponent. The real value is `price * 10**expo`, computed exactly as a `Decimal`:
+
+```python
+from pyth_hermes import price_to_decimal
+price_to_decimal(6395282153102, -8)   # Decimal("63952.82153102")
+```
+
+`RpcPrice.to_decimal()` and `ParsedPriceUpdate.to_decimal()` are convenience wrappers.
+
+## Finding feed ids — use the EXACT symbol
+
+`/v2/price_feeds?query=btc` returns **deprecated / variant** feeds (e.g. `MBTC`, `XBTC`) *before* the canonical one and matches substrings. `get_feed_id()` therefore matches on exact `attributes.symbol`:
+
+```python
+client.get_feed_id("Crypto.BTC/USD")
+# -> "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+```
+
+## 🔴 Authentication (changes 2026-07-31)
+
+Today the public endpoint needs **no** API key. **From 2026-07-31 an API key becomes mandatory.** This client accepts one from day one — pass it now to be ready:
+
+```python
+client = HermesClient(api_key="YOUR_KEY")  # default: Authorization: Bearer YOUR_KEY
+```
+
+The exact header is not finalized publicly, so both the header name and scheme are configurable:
+
+```python
+HermesClient(api_key="KEY", api_key_header="X-Api-Key", api_key_scheme="")  # -> X-Api-Key: KEY
+```
+
+## Endpoints / base URLs
+
+```python
+from pyth_hermes import HermesClient
+
+HermesClient()                                           # production: https://hermes.pyth.network
+HermesClient(base_url="https://hermes-beta.pyth.network")  # beta
+HermesClient(base_url="https://your-paid-provider.example")  # Triton / P2P / extrnode / Liquify
+```
+
+You may also inject your own preconfigured `httpx.Client` / `httpx.AsyncClient` via `client=...` (e.g. for custom transports, proxies, or connection pools). In that case the request host is taken from **your** client, so set `base_url` on the client itself — passing both `base_url=` and `client=` raises a `UserWarning` because the constructor's `base_url` would be a no-op. The `api_key` is still applied per-request, so it works with an injected client.
+
+```python
+import httpx
+from pyth_hermes import HermesClient
+
+http = httpx.Client(base_url="https://your-paid-provider.example", proxy="http://localhost:8080")
+client = HermesClient(api_key="KEY", client=http)  # base_url comes from `http`
+```
+
+## Rate limits
+
+The public endpoint allows **10 requests / 10 seconds per IP**. Exceeding it returns HTTP 429 for the next 60 seconds. The client retries 429 and 5xx responses with exponential backoff + jitter, honoring any `Retry-After` header and never exceeding the 60s rate-limit window per delay. Tune via `max_retries`, `backoff_base`, `backoff_cap`.
+
+## Not implemented
+
+The TWAP endpoints (`/v2/updates/twap/...`) are intentionally omitted — the API returns HTTP 400 "deprecated and no longer available".
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest                 # unit tests (no network)
+pytest -m integration  # live smoke tests against production
+mypy
+ruff check .
+```
+
+## License
+
+MIT

pyth_hermes-0.1.0/examples/get_btc_price.py

@@ -0,0 +1,22 @@
+"""Get the latest canonical BTC/USD price from Hermes (production, no auth today).
+
+Run: python examples/get_btc_price.py
+"""
+
+from __future__ import annotations
+
+from pyth_hermes import HermesClient
+
+
+def main() -> None:
+    with HermesClient() as client:
+        feed_id = client.get_feed_id("Crypto.BTC/USD")
+        if feed_id is None:
+            raise SystemExit("BTC/USD feed not found")
+        print(f"Crypto.BTC/USD feed id: {feed_id}")
+        price = client.get_price_decimal(feed_id)
+        print(f"BTC/USD = ${price:,.2f}")
+
+
+if __name__ == "__main__":
+    main()

pyth_hermes-0.1.0/examples/historical_price.py

@@ -0,0 +1,30 @@
+"""Fetch a historical BTC/USD price at a given unix timestamp.
+
+Run: python examples/historical_price.py
+"""
+
+from __future__ import annotations
+
+import time
+
+from pyth_hermes import HermesClient
+
+BTC_ID = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+
+
+def main() -> None:
+    # one hour ago
+    publish_time = int(time.time()) - 3600
+    with HermesClient() as client:
+        resp = client.get_price_at(publish_time, [BTC_ID])
+        if not resp.parsed:
+            raise SystemExit("no historical update returned")
+        price = resp.parsed[0]
+        print(
+            f"BTC/USD around {publish_time}: "
+            f"${price.to_decimal():,.2f} (published {price.price.publish_time})"
+        )
+
+
+if __name__ == "__main__":
+    main()

pyth_hermes-0.1.0/examples/stream_prices.py

@@ -0,0 +1,29 @@
+"""Stream live BTC/USD price updates via SSE with automatic reconnect.
+
+Run: python examples/stream_prices.py  (Ctrl-C to stop)
+"""
+
+from __future__ import annotations
+
+import asyncio
+
+from pyth_hermes import AsyncHermesClient
+
+BTC_ID = "e62df6c8b4a85fe1a67db44dc12de5db330f7ac66b72dc658afedf0f4a415b43"
+
+
+async def main() -> None:
+    async with AsyncHermesClient() as client:
+        count = 0
+        async for update in client.stream_prices([BTC_ID]):
+            if not update.parsed:
+                continue
+            price = update.parsed[0]
+            print(f"BTC/USD = ${price.to_decimal():,.2f}  @ {price.price.publish_time}")
+            count += 1
+            if count >= 5:  # demo: stop after 5 ticks
+                break
+
+
+if __name__ == "__main__":
+    asyncio.run(main())