odos-py 0.1.0__tar.gz

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

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12"]
+    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,exec]"
+
+      - name: Ruff
+        run: ruff check .
+
+      - name: Mypy (strict)
+        # mypy targets 3.10 (see pyproject) and the pinned mypy does not run on
+        # 3.9; the 3.9 job exists to prove the package imports and runs there.
+        if: matrix.python-version != '3.9'
+        run: mypy
+
+      - name: Pytest
+        run: pytest -q

odos_py-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

odos_py-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.

odos_py-0.1.0/PKG-INFO

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: odos-py
+Version: 0.1.0
+Summary: A modern Python client for the Odos DEX Aggregator API
+Project-URL: Homepage, https://github.com/robertruben98/odos-py
+Project-URL: Documentation, https://docs.odos.xyz/build/api-docs
+Project-URL: Repository, https://github.com/robertruben98/odos-py
+Project-URL: Issues, https://github.com/robertruben98/odos-py/issues
+Author: robertdev
+License: MIT
+License-File: LICENSE
+Keywords: aggregator,defi,dex,ethereum,odos,swap
+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: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.24
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.5; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: respx>=0.20; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Provides-Extra: exec
+Requires-Dist: web3>=6.0; extra == 'exec'
+Description-Content-Type: text/markdown
+
+# odos-py
+
+A modern, fully-typed Python client for the [Odos](https://docs.odos.xyz/build/api-docs) DEX Aggregator API.
+
+- Sync (`OdosClient`) and async (`AsyncOdosClient`) clients built on `httpx`
+- `pydantic` v2 models for all requests and responses
+- Automatic HTTP 429 handling with exponential backoff
+- Configurable base URL and API-key header
+- `mypy --strict` clean, ships a `py.typed` marker
+
+## Install
+
+```bash
+pip install odos-py
+```
+
+Optional extra for signing/sending the assembled transaction with `web3.py`:
+
+```bash
+pip install "odos-py[exec]"
+```
+
+## Quickstart
+
+Odos works in two steps: `quote` returns a `pathId`, then `assemble` turns that
+`pathId` into ready-to-sign transaction calldata. The `swap()` helper chains
+both:
+
+```python
+from odos_py import OdosClient, QuoteRequest, InputToken, OutputToken
+
+client = OdosClient(api_key="YOUR_KEY")  # api_key optional but recommended
+quote, assembled = client.swap(QuoteRequest(
+    chain_id=1,
+    input_tokens=[InputToken(token_address="0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",  # WETH
+                             amount="1000000000000000000")],                              # 1 WETH (wei)
+    output_tokens=[OutputToken(token_address="0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",  # USDC
+                               proportion=1)],
+    user_addr="0x47E2D28169738039755586743E2dfCF3bd643f86",
+    slippage_limit_percent=0.3,
+))
+print(quote.path_id, assembled.transaction.to)
+```
+
+Async is identical with `await`:
+
+```python
+import asyncio
+from odos_py import AsyncOdosClient
+
+async def main(request):
+    async with AsyncOdosClient() as client:
+        quote = await client.quote(request)
+        print(quote.path_id)
+```
+
+## Auth & rate limits
+
+There is a free, **keyless** tier, but it is heavily rate limited — `POST
+/sor/quote/v2` returns HTTP 429 quickly without a key. Pass an `api_key` to
+raise limits. The exact API-key header name is not publicly documented, so it
+is configurable:
+
+```python
+OdosClient(api_key="YOUR_KEY", api_key_header="x-api-key")  # default header name
+```
+
+The client retries 429 responses with exponential backoff (honouring any
+`Retry-After` header) and raises `OdosRateLimitError` once retries are
+exhausted. Tune with `max_retries` and `backoff_base`.
+
+## Endpoints
+
+| Method | Endpoint |
+| --- | --- |
+| `quote(request)` | `POST /sor/quote/v2` |
+| `assemble(user_addr=, path_id=)` | `POST /sor/assemble` |
+| `execute(user_addr=, path_id=)` | `POST /sor/execute` |
+| `swap(request)` / `quote_and_assemble(request)` | quote then assemble |
+| `get_chains()` | `GET /info/chains` |
+| `get_tokens(chain_id)` | `GET /info/tokens/{chainId}` |
+| `get_router(chain_id)` | `GET /info/router/v2/{chainId}` |
+| `get_contract_info(chain_id)` | `GET /info/contract-info/v2/{chainId}` |
+| `get_token_price(chain_id, token_address)` | `GET /pricing/token/{chainId}/{tokenAddress}` |
+
+Multi-chain is handled per call via `chain_id` on `QuoteRequest` and the info
+endpoints.
+
+## Configuration
+
+```python
+OdosClient(
+    base_url="https://api.odos.xyz",  # configurable / proxyable
+    api_key=None,
+    api_key_header="x-api-key",
+    max_retries=3,
+    backoff_base=0.5,
+    timeout=30.0,
+)
+```
+
+## Development
+
+```bash
+pip install -e ".[dev,exec]"
+pytest                  # unit tests (HTTP mocked, no network)
+pytest -m integration   # live smoke test against /info/chains
+ruff check .
+mypy
+```
+
+## License
+
+MIT

odos_py-0.1.0/README.md

@@ -0,0 +1,114 @@
+# odos-py
+
+A modern, fully-typed Python client for the [Odos](https://docs.odos.xyz/build/api-docs) DEX Aggregator API.
+
+- Sync (`OdosClient`) and async (`AsyncOdosClient`) clients built on `httpx`
+- `pydantic` v2 models for all requests and responses
+- Automatic HTTP 429 handling with exponential backoff
+- Configurable base URL and API-key header
+- `mypy --strict` clean, ships a `py.typed` marker
+
+## Install
+
+```bash
+pip install odos-py
+```
+
+Optional extra for signing/sending the assembled transaction with `web3.py`:
+
+```bash
+pip install "odos-py[exec]"
+```
+
+## Quickstart
+
+Odos works in two steps: `quote` returns a `pathId`, then `assemble` turns that
+`pathId` into ready-to-sign transaction calldata. The `swap()` helper chains
+both:
+
+```python
+from odos_py import OdosClient, QuoteRequest, InputToken, OutputToken
+
+client = OdosClient(api_key="YOUR_KEY")  # api_key optional but recommended
+quote, assembled = client.swap(QuoteRequest(
+    chain_id=1,
+    input_tokens=[InputToken(token_address="0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",  # WETH
+                             amount="1000000000000000000")],                              # 1 WETH (wei)
+    output_tokens=[OutputToken(token_address="0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",  # USDC
+                               proportion=1)],
+    user_addr="0x47E2D28169738039755586743E2dfCF3bd643f86",
+    slippage_limit_percent=0.3,
+))
+print(quote.path_id, assembled.transaction.to)
+```
+
+Async is identical with `await`:
+
+```python
+import asyncio
+from odos_py import AsyncOdosClient
+
+async def main(request):
+    async with AsyncOdosClient() as client:
+        quote = await client.quote(request)
+        print(quote.path_id)
+```
+
+## Auth & rate limits
+
+There is a free, **keyless** tier, but it is heavily rate limited — `POST
+/sor/quote/v2` returns HTTP 429 quickly without a key. Pass an `api_key` to
+raise limits. The exact API-key header name is not publicly documented, so it
+is configurable:
+
+```python
+OdosClient(api_key="YOUR_KEY", api_key_header="x-api-key")  # default header name
+```
+
+The client retries 429 responses with exponential backoff (honouring any
+`Retry-After` header) and raises `OdosRateLimitError` once retries are
+exhausted. Tune with `max_retries` and `backoff_base`.
+
+## Endpoints
+
+| Method | Endpoint |
+| --- | --- |
+| `quote(request)` | `POST /sor/quote/v2` |
+| `assemble(user_addr=, path_id=)` | `POST /sor/assemble` |
+| `execute(user_addr=, path_id=)` | `POST /sor/execute` |
+| `swap(request)` / `quote_and_assemble(request)` | quote then assemble |
+| `get_chains()` | `GET /info/chains` |
+| `get_tokens(chain_id)` | `GET /info/tokens/{chainId}` |
+| `get_router(chain_id)` | `GET /info/router/v2/{chainId}` |
+| `get_contract_info(chain_id)` | `GET /info/contract-info/v2/{chainId}` |
+| `get_token_price(chain_id, token_address)` | `GET /pricing/token/{chainId}/{tokenAddress}` |
+
+Multi-chain is handled per call via `chain_id` on `QuoteRequest` and the info
+endpoints.
+
+## Configuration
+
+```python
+OdosClient(
+    base_url="https://api.odos.xyz",  # configurable / proxyable
+    api_key=None,
+    api_key_header="x-api-key",
+    max_retries=3,
+    backoff_base=0.5,
+    timeout=30.0,
+)
+```
+
+## Development
+
+```bash
+pip install -e ".[dev,exec]"
+pytest                  # unit tests (HTTP mocked, no network)
+pytest -m integration   # live smoke test against /info/chains
+ruff check .
+mypy
+```
+
+## License
+
+MIT

odos_py-0.1.0/examples/async_quote.py

@@ -0,0 +1,34 @@
+"""Async variant: quote WETH -> USDC on Ethereum mainnet.
+
+python examples/async_quote.py
+"""
+
+from __future__ import annotations
+
+import asyncio
+import os
+
+from odos_py import AsyncOdosClient, InputToken, OutputToken, QuoteRequest
+
+WETH = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
+USDC = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
+USER = "0x47E2D28169738039755586743E2dfCF3bd643f86"
+
+
+async def main() -> None:
+    request = QuoteRequest(
+        chain_id=1,
+        input_tokens=[InputToken(token_address=WETH, amount="1000000000000000000")],
+        output_tokens=[OutputToken(token_address=USDC, proportion=1)],
+        user_addr=USER,
+        slippage_limit_percent=0.3,
+    )
+
+    async with AsyncOdosClient(api_key=os.environ.get("ODOS_API_KEY")) as client:
+        quote = await client.quote(request)
+        print(f"pathId:     {quote.path_id}")
+        print(f"out amount: {quote.out_amounts}")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

odos_py-0.1.0/examples/quote_and_assemble.py

@@ -0,0 +1,44 @@
+"""Quote WETH -> USDC on Ethereum mainnet, then assemble the transaction.
+
+This reproduces the validated flow. The quote endpoint is heavily rate limited
+without an API key, so set ODOS_API_KEY to avoid HTTP 429.
+
+    python examples/quote_and_assemble.py
+"""
+
+from __future__ import annotations
+
+import os
+
+from odos_py import InputToken, OdosClient, OutputToken, QuoteRequest
+
+WETH = "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
+USDC = "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
+USER = "0x47E2D28169738039755586743E2dfCF3bd643f86"
+
+
+def main() -> None:
+    client = OdosClient(api_key=os.environ.get("ODOS_API_KEY"))
+
+    request = QuoteRequest(
+        chain_id=1,
+        input_tokens=[InputToken(token_address=WETH, amount="1000000000000000000")],  # 1 WETH
+        output_tokens=[OutputToken(token_address=USDC, proportion=1)],
+        user_addr=USER,
+        slippage_limit_percent=0.3,
+    )
+
+    quote, assembled = client.swap(request)
+
+    print(f"pathId:     {quote.path_id}")
+    print(f"out amount: {quote.out_amounts}")
+    if assembled.transaction is not None:
+        data = assembled.transaction.data
+        print(f"tx to:      {assembled.transaction.to}")
+        print(f"tx data:    {data[:42] + '...' if data else None}")
+
+    client.close()
+
+
+if __name__ == "__main__":
+    main()

odos_py-0.1.0/pyproject.toml

@@ -0,0 +1,72 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "odos-py"
+version = "0.1.0"
+description = "A modern Python client for the Odos DEX Aggregator API"
+readme = "README.md"
+license = { text = "MIT" }
+requires-python = ">=3.9"
+authors = [{ name = "robertdev" }]
+keywords = ["odos", "dex", "aggregator", "defi", "ethereum", "swap"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Typing :: Typed",
+]
+dependencies = [
+    "httpx>=0.24",
+    "pydantic>=2.0",
+]
+
+[project.optional-dependencies]
+exec = ["web3>=6.0"]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "respx>=0.20",
+    "mypy>=1.5",
+    "ruff>=0.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/robertruben98/odos-py"
+Documentation = "https://docs.odos.xyz/build/api-docs"
+Repository = "https://github.com/robertruben98/odos-py"
+Issues = "https://github.com/robertruben98/odos-py/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/odos_py"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "W"]
+# Keep typing.Optional/Union: PEP 604 (`X | None`) in evaluated annotations is
+# not safe on the 3.9 runtime we still support.
+ignore = ["UP006", "UP007", "UP035", "UP045"]
+
+[tool.mypy]
+# Runtime supports 3.9+, but this mypy version requires a 3.10+ target.
+python_version = "3.10"
+strict = true
+warn_unused_configs = true
+files = ["src/odos_py"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+markers = [
+    "integration: marks tests that hit the live network (deselected by default)",
+]
+addopts = "-m 'not integration'"