rulebook-sdk 0.1.0__tar.gz

rulebook_sdk-0.1.0/.gitignore

@@ -0,0 +1,219 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+
+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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+ops-portal/tsconfig.tsbuildinfo
+.claude/settings.local.json
+rulebook-crawler/.env.local
+.worktrees/

rulebook_sdk-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

rulebook_sdk-0.1.0/LICENSE

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

rulebook_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,254 @@
+Metadata-Version: 2.4
+Name: rulebook-sdk
+Version: 0.1.0
+Summary: Python SDK for the Rulebook Company API — exchange fee schedule and rebate data
+Project-URL: Documentation, https://docs.rulebookcompany.com
+Project-URL: Changelog, https://docs.rulebookcompany.com/changelog
+Author-email: Muhammad Haris Azaz Khan <harris.khan.1596@gmail.com>
+Maintainer-email: Muhammad Haris Azaz Khan <harris.khan.1596@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,exchange,fee-schedule,fintech,rebate,rulebook,sdk,trading
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: anyio>=4.0.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: pydantic>=2.0.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.30.0; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4.0; extra == 'dev'
+Requires-Dist: vcrpy>=8.1.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Rulebook Python SDK
+
+The official Python client for the [Rulebook Company API](https://api.rulebook.company) — access exchange fee schedule and rebate data across US trading venues.
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Installation
+
+```bash
+pip install rulebooksdk
+```
+
+## Usage
+
+```python
+from rulebook import Rulebook
+
+client = Rulebook(api_key="your-api-key")
+
+# List all exchanges
+exchanges = client.exchanges.list()
+for exchange in exchanges:
+    print(f"{exchange.name}: {exchange.display_name} ({exchange.record_count} records)")
+
+# Get details for a specific exchange
+detail = client.exchanges.retrieve("NYSE")
+print(f"Date range: {detail.date_range.earliest} to {detail.date_range.latest}")
+print(f"Fee types: {detail.fee_types}")
+print(f"Actions: {detail.actions}")
+
+# List fee schedule results (with filtering)
+results = client.fee_schedule_results.list(
+    exchange_name=["fee_cboe_us_options"],
+    fee_type=["Option"],
+    latest_only=True,
+    page_size=10,
+)
+for item in results.data:
+    print(f"{item.exchange_name} | {item.fee_type} | {item.fee_amount}")
+
+# Get a single fee schedule result
+result = client.fee_schedule_results.retrieve("some-uuid")
+
+# Get available filter values
+filters = client.fee_schedule_results.get_filters()
+print(f"Exchanges: {filters.exchange_names}")
+print(f"Fee types: {filters.fee_types}")
+
+# Get results by extraction version
+version_results = client.fee_schedule_results.get_results_by_version("version-uuid")
+
+client.close()
+```
+
+## Authentication
+
+Pass your API key directly or set the `RULEBOOK_API_KEY` environment variable:
+
+```python
+# Option 1: Pass directly
+client = Rulebook(api_key="rb-...")
+
+# Option 2: Environment variable
+# export RULEBOOK_API_KEY=rb-...
+client = Rulebook()
+```
+
+## Async support
+
+Every method has an async counterpart via `AsyncRulebook`:
+
+```python
+import asyncio
+from rulebook import AsyncRulebook
+
+async def main():
+    async with AsyncRulebook(api_key="your-api-key") as client:
+        exchanges = await client.exchanges.list()
+        detail = await client.exchanges.retrieve("NYSE")
+
+asyncio.run(main())
+```
+
+## Error handling
+
+The SDK raises typed exceptions for all API errors:
+
+```python
+from rulebook import Rulebook, NotFoundError, AuthenticationError, RateLimitError
+
+client = Rulebook()
+
+try:
+    detail = client.exchanges.retrieve("UNKNOWN")
+except NotFoundError:
+    print("Exchange not found")
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError as e:
+    print(f"Rate limited — retry after: {e.response.headers.get('retry-after')}")
+```
+
+**Exception hierarchy:**
+
+| Exception | Status Code | Description |
+|---|---|---|
+| `BadRequestError` | 400 | Invalid request parameters |
+| `AuthenticationError` | 401 | Missing or invalid API key |
+| `PermissionDeniedError` | 403 | Insufficient access for this resource |
+| `NotFoundError` | 404 | Resource does not exist |
+| `UnprocessableEntityError` | 422 | Request validation failed |
+| `RateLimitError` | 429 | Too many requests |
+| `InternalServerError` | 5xx | Server-side error |
+| `APIConnectionError` | — | Network failure |
+| `APITimeoutError` | — | Request timed out |
+
+## Raw response access
+
+Access HTTP status codes, headers, and the raw response via `with_raw_response`:
+
+```python
+raw = client.exchanges.with_raw_response.retrieve("NYSE")
+print(raw.status_code)                      # 200
+print(raw.headers.get("content-type"))      # application/json
+
+detail = raw.parse()                        # ExchangeDetail
+```
+
+## Client configuration
+
+```python
+client = Rulebook(
+    api_key="rb-...",
+    base_url="https://api.rulebook.company/api/v1",  # default
+    timeout=30.0,         # seconds (default: 30)
+    max_retries=2,        # retry transient failures (default: 2)
+    default_headers={},   # headers sent on every request
+)
+```
+
+### Per-request overrides
+
+Override timeout or add headers for a single request without modifying the client:
+
+```python
+exchanges = client.exchanges.list(
+    extra_headers={"X-Request-Id": "abc-123"},
+    timeout=60.0,
+)
+```
+
+### Immutable client copies
+
+Create a new client with different settings using `with_options()`:
+
+```python
+slow_client = client.with_options(timeout=120.0)
+```
+
+## Retries
+
+The SDK automatically retries transient errors (408, 409, 429, 500, 502, 503, 504) with exponential backoff and jitter. Configure with `max_retries`:
+
+```python
+client = Rulebook(max_retries=5)  # default is 2
+```
+
+## Response types
+
+All responses are strongly typed with Pydantic models:
+
+```python
+from rulebook.types import (
+    Exchange,
+    ExchangeDetail,
+    DateRange,
+    FeeScheduleResult,
+    FeeScheduleResultFilters,
+    PaginatedResponse,
+)
+```
+
+**`Exchange`** — returned by `list()`
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | `str` | Exchange identifier (e.g., `"NYSE"`) |
+| `display_name` | `str` | Full name (e.g., `"New York Stock Exchange"`) |
+| `fee_types` | `List[str]` | Available fee types (e.g., `["Equity", "Option"]`) |
+| `record_count` | `int` | Total fee schedule records |
+
+**`ExchangeDetail`** — returned by `retrieve()`
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | `str` | Exchange identifier |
+| `display_name` | `str` | Full name |
+| `date_range` | `DateRange` | Earliest and latest dates of available data |
+| `fee_types` | `List[str]` | Available fee types |
+| `fee_categories` | `List[str]` | Fee categories (e.g., `["Fee And Rebates"]`) |
+| `actions` | `List[str]` | Trade actions (e.g., `["Make", "Take", "Open"]`) |
+| `participants` | `List[str]` | Participant types (e.g., `["Market Maker", "Customer"]`) |
+| `symbol_classifications` | `List[str]` | Symbol classifications (e.g., `["ETF", "Equity"]`) |
+| `symbol_types` | `List[str]` | Symbol types (e.g., `["Penny", "Non Penny"]`) |
+| `trade_types` | `List[str]` | Trade types (e.g., `["Simple Order"]`) |
+| `record_count` | `int` | Total fee schedule records |
+
+## Maintainers
+
+- [Muhammad Haris Azaz Khan](https://github.com/haris-khan1596)
+
+## Requirements
+
+- Python 3.11+
+- Dependencies: `httpx`, `pydantic`, `anyio`
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.

rulebook_sdk-0.1.0/README.md

@@ -0,0 +1,220 @@
+# Rulebook Python SDK
+
+The official Python client for the [Rulebook Company API](https://api.rulebook.company) — access exchange fee schedule and rebate data across US trading venues.
+
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
+
+## Installation
+
+```bash
+pip install rulebooksdk
+```
+
+## Usage
+
+```python
+from rulebook import Rulebook
+
+client = Rulebook(api_key="your-api-key")
+
+# List all exchanges
+exchanges = client.exchanges.list()
+for exchange in exchanges:
+    print(f"{exchange.name}: {exchange.display_name} ({exchange.record_count} records)")
+
+# Get details for a specific exchange
+detail = client.exchanges.retrieve("NYSE")
+print(f"Date range: {detail.date_range.earliest} to {detail.date_range.latest}")
+print(f"Fee types: {detail.fee_types}")
+print(f"Actions: {detail.actions}")
+
+# List fee schedule results (with filtering)
+results = client.fee_schedule_results.list(
+    exchange_name=["fee_cboe_us_options"],
+    fee_type=["Option"],
+    latest_only=True,
+    page_size=10,
+)
+for item in results.data:
+    print(f"{item.exchange_name} | {item.fee_type} | {item.fee_amount}")
+
+# Get a single fee schedule result
+result = client.fee_schedule_results.retrieve("some-uuid")
+
+# Get available filter values
+filters = client.fee_schedule_results.get_filters()
+print(f"Exchanges: {filters.exchange_names}")
+print(f"Fee types: {filters.fee_types}")
+
+# Get results by extraction version
+version_results = client.fee_schedule_results.get_results_by_version("version-uuid")
+
+client.close()
+```
+
+## Authentication
+
+Pass your API key directly or set the `RULEBOOK_API_KEY` environment variable:
+
+```python
+# Option 1: Pass directly
+client = Rulebook(api_key="rb-...")
+
+# Option 2: Environment variable
+# export RULEBOOK_API_KEY=rb-...
+client = Rulebook()
+```
+
+## Async support
+
+Every method has an async counterpart via `AsyncRulebook`:
+
+```python
+import asyncio
+from rulebook import AsyncRulebook
+
+async def main():
+    async with AsyncRulebook(api_key="your-api-key") as client:
+        exchanges = await client.exchanges.list()
+        detail = await client.exchanges.retrieve("NYSE")
+
+asyncio.run(main())
+```
+
+## Error handling
+
+The SDK raises typed exceptions for all API errors:
+
+```python
+from rulebook import Rulebook, NotFoundError, AuthenticationError, RateLimitError
+
+client = Rulebook()
+
+try:
+    detail = client.exchanges.retrieve("UNKNOWN")
+except NotFoundError:
+    print("Exchange not found")
+except AuthenticationError:
+    print("Invalid API key")
+except RateLimitError as e:
+    print(f"Rate limited — retry after: {e.response.headers.get('retry-after')}")
+```
+
+**Exception hierarchy:**
+
+| Exception | Status Code | Description |
+|---|---|---|
+| `BadRequestError` | 400 | Invalid request parameters |
+| `AuthenticationError` | 401 | Missing or invalid API key |
+| `PermissionDeniedError` | 403 | Insufficient access for this resource |
+| `NotFoundError` | 404 | Resource does not exist |
+| `UnprocessableEntityError` | 422 | Request validation failed |
+| `RateLimitError` | 429 | Too many requests |
+| `InternalServerError` | 5xx | Server-side error |
+| `APIConnectionError` | — | Network failure |
+| `APITimeoutError` | — | Request timed out |
+
+## Raw response access
+
+Access HTTP status codes, headers, and the raw response via `with_raw_response`:
+
+```python
+raw = client.exchanges.with_raw_response.retrieve("NYSE")
+print(raw.status_code)                      # 200
+print(raw.headers.get("content-type"))      # application/json
+
+detail = raw.parse()                        # ExchangeDetail
+```
+
+## Client configuration
+
+```python
+client = Rulebook(
+    api_key="rb-...",
+    base_url="https://api.rulebook.company/api/v1",  # default
+    timeout=30.0,         # seconds (default: 30)
+    max_retries=2,        # retry transient failures (default: 2)
+    default_headers={},   # headers sent on every request
+)
+```
+
+### Per-request overrides
+
+Override timeout or add headers for a single request without modifying the client:
+
+```python
+exchanges = client.exchanges.list(
+    extra_headers={"X-Request-Id": "abc-123"},
+    timeout=60.0,
+)
+```
+
+### Immutable client copies
+
+Create a new client with different settings using `with_options()`:
+
+```python
+slow_client = client.with_options(timeout=120.0)
+```
+
+## Retries
+
+The SDK automatically retries transient errors (408, 409, 429, 500, 502, 503, 504) with exponential backoff and jitter. Configure with `max_retries`:
+
+```python
+client = Rulebook(max_retries=5)  # default is 2
+```
+
+## Response types
+
+All responses are strongly typed with Pydantic models:
+
+```python
+from rulebook.types import (
+    Exchange,
+    ExchangeDetail,
+    DateRange,
+    FeeScheduleResult,
+    FeeScheduleResultFilters,
+    PaginatedResponse,
+)
+```
+
+**`Exchange`** — returned by `list()`
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | `str` | Exchange identifier (e.g., `"NYSE"`) |
+| `display_name` | `str` | Full name (e.g., `"New York Stock Exchange"`) |
+| `fee_types` | `List[str]` | Available fee types (e.g., `["Equity", "Option"]`) |
+| `record_count` | `int` | Total fee schedule records |
+
+**`ExchangeDetail`** — returned by `retrieve()`
+
+| Field | Type | Description |
+|---|---|---|
+| `name` | `str` | Exchange identifier |
+| `display_name` | `str` | Full name |
+| `date_range` | `DateRange` | Earliest and latest dates of available data |
+| `fee_types` | `List[str]` | Available fee types |
+| `fee_categories` | `List[str]` | Fee categories (e.g., `["Fee And Rebates"]`) |
+| `actions` | `List[str]` | Trade actions (e.g., `["Make", "Take", "Open"]`) |
+| `participants` | `List[str]` | Participant types (e.g., `["Market Maker", "Customer"]`) |
+| `symbol_classifications` | `List[str]` | Symbol classifications (e.g., `["ETF", "Equity"]`) |
+| `symbol_types` | `List[str]` | Symbol types (e.g., `["Penny", "Non Penny"]`) |
+| `trade_types` | `List[str]` | Trade types (e.g., `["Simple Order"]`) |
+| `record_count` | `int` | Total fee schedule records |
+
+## Maintainers
+
+- [Muhammad Haris Azaz Khan](https://github.com/haris-khan1596)
+
+## Requirements
+
+- Python 3.11+
+- Dependencies: `httpx`, `pydantic`, `anyio`
+
+## License
+
+MIT — see [LICENSE](LICENSE) for details.