vanda-api 0.1.0__tar.gz

vanda_api-0.1.0/.gitignore

@@ -0,0 +1,15 @@
+.venv/
+.venv/*
+*.ipynb
+__pycache__/
+*.pyc
+*.pyo
+*.pyd
+*.db
+*.sqlite3
+.env
+.venv
+.git
+logs/*
+logs
+.DS_Store

vanda_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2024-02-06
+
+### Added
+
+- Initial release
+- Synchronous VandaClient
+- Asynchronous AsyncVandaClient
+- All 12 API endpoints implemented
+- Retry logic with exponential backoff
+- Comprehensive error handling
+- Job polling utilities
+- CSV/JSONL export support
+- Optional pandas support
+- Type hints throughout
+- Full test coverage
+- CI/CD with GitHub Actions

vanda_api-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Vanda LTD
+
+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.

vanda_api-0.1.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: vanda-api
+Version: 0.1.0
+Summary: Official Python SDK for Vanda Analytics Data API
+Project-URL: Homepage, https://gitlab.com/yourusername/vanda-api
+Project-URL: Documentation, https://gitlab.com/yourusername/vanda-api#readme
+Project-URL: Repository, https://gitlab.com/yourusername/vanda-api
+Project-URL: Issues, https://gitlab.com/yourusername/vanda-api/-/issues
+Author-email: Jonathan Aina <Jonathan.Aina@vanda.com>
+License: MIT
+License-File: LICENSE
+Keywords: analytics,api,finance,market-data,retail-trading,vanda
+Classifier: Development Status :: 4 - Beta
+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.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.27.0
+Provides-Extra: dev
+Requires-Dist: black>=23.0.0; extra == 'dev'
+Requires-Dist: mypy>=1.5.0; extra == 'dev'
+Requires-Dist: pandas-stubs>=2.0.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.3.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=7.4.0; extra == 'dev'
+Requires-Dist: respx>=0.20.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Provides-Extra: pandas
+Requires-Dist: pandas>=1.5.0; extra == 'pandas'
+Description-Content-Type: text/markdown
+
+# Vanda Analytics Data API SDK
+
+Official Python SDK for the Vanda Analytics Data API.
+
+## Installation
+
+```bash
+pip install vanda-api
+```
+
+For pandas support:
+
+```bash
+pip install vanda-api[pandas]
+```
+
+## Quick Start
+
+### Synchronous Client
+
+```python
+from datetime import date
+from vanda import VandaClient
+
+with VandaClient(token="YOUR_TOKEN_HERE") as client:
+    data = client.get_timeseries(
+        symbol="TSLA",
+        start_date=date(2025, 12, 1),
+        end_date=date(2025, 12, 31),
+        fields=["retail_net_turnover", "retail_buy_turnover"],
+    )
+    print(f"Retrieved {len(data)} records")
+```
+
+### Asynchronous Client
+
+```python
+import asyncio
+from datetime import date
+from vanda import AsyncVandaClient
+
+async def main():
+    async with AsyncVandaClient(token="YOUR_TOKEN_HERE") as client:
+        data = await client.get_timeseries(
+            symbol="TSLA",
+            start_date=date(2025, 12, 1),
+            end_date=date(2025, 12, 31),
+            fields=["retail_net_turnover"],
+        )
+        print(f"Retrieved {len(data)} records")
+
+asyncio.run(main())
+```
+
+## Authentication
+
+Set your API token via environment variable:
+
+```bash
+export VANDA_API_TOKEN="your_token_here"
+```
+
+Or pass directly:
+
+```python
+client = VandaClient(token="your_token_here")
+```
+
+## Features
+
+- Sync and async clients with consistent interfaces
+- Automatic retry with exponential backoff
+- Comprehensive error handling
+- Job polling for async operations
+- Export utilities (CSV, JSONL)
+- Optional pandas support
+- Type hints throughout
+
+## API Methods
+
+### Timeseries Data
+
+- `get_timeseries()` - Get timeseries for a single symbol
+- `get_timeseries_many()` - Get timeseries for multiple symbols
+- `get_leaderboard()` - Get ranked leaderboard data
+
+### Bulk Operations
+
+- `bulk_securities()` - Bulk fetch securities data
+- `get_daily_snapshot()` - Get daily snapshot for many securities
+
+### Job Management
+
+- `create_bulk_securities_job()` - Create async job
+- `poll_job()` - Poll job until completion
+- `get_job_status()` - Get job status
+- `export_job_result()` - Export job result to file
+- `stream_job_result()` - Stream job result to file
+
+### Export Operations
+
+- `export_timeseries()` - Export timeseries to file
+
+### Metadata
+
+- `list_fields()` - List available fields
+- `list_intervals()` - List available intervals
+- `list_securities()` - List available securities
+
+## Examples
+
+See `examples/` directory for complete usage examples.
+
+## Requirements
+
+- Python 3.9+
+- httpx
+
+## Development
+
+```bash
+git clone https://gitlab.com/yourusername/vanda-api.git
+cd vanda-api
+python -m venv venv
+source venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install
+pytest
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions, please open an issue on GitLab.

vanda_api-0.1.0/README.md

@@ -0,0 +1,137 @@
+# Vanda Analytics Data API SDK
+
+Official Python SDK for the Vanda Analytics Data API.
+
+## Installation
+
+```bash
+pip install vanda-api
+```
+
+For pandas support:
+
+```bash
+pip install vanda-api[pandas]
+```
+
+## Quick Start
+
+### Synchronous Client
+
+```python
+from datetime import date
+from vanda import VandaClient
+
+with VandaClient(token="YOUR_TOKEN_HERE") as client:
+    data = client.get_timeseries(
+        symbol="TSLA",
+        start_date=date(2025, 12, 1),
+        end_date=date(2025, 12, 31),
+        fields=["retail_net_turnover", "retail_buy_turnover"],
+    )
+    print(f"Retrieved {len(data)} records")
+```
+
+### Asynchronous Client
+
+```python
+import asyncio
+from datetime import date
+from vanda import AsyncVandaClient
+
+async def main():
+    async with AsyncVandaClient(token="YOUR_TOKEN_HERE") as client:
+        data = await client.get_timeseries(
+            symbol="TSLA",
+            start_date=date(2025, 12, 1),
+            end_date=date(2025, 12, 31),
+            fields=["retail_net_turnover"],
+        )
+        print(f"Retrieved {len(data)} records")
+
+asyncio.run(main())
+```
+
+## Authentication
+
+Set your API token via environment variable:
+
+```bash
+export VANDA_API_TOKEN="your_token_here"
+```
+
+Or pass directly:
+
+```python
+client = VandaClient(token="your_token_here")
+```
+
+## Features
+
+- Sync and async clients with consistent interfaces
+- Automatic retry with exponential backoff
+- Comprehensive error handling
+- Job polling for async operations
+- Export utilities (CSV, JSONL)
+- Optional pandas support
+- Type hints throughout
+
+## API Methods
+
+### Timeseries Data
+
+- `get_timeseries()` - Get timeseries for a single symbol
+- `get_timeseries_many()` - Get timeseries for multiple symbols
+- `get_leaderboard()` - Get ranked leaderboard data
+
+### Bulk Operations
+
+- `bulk_securities()` - Bulk fetch securities data
+- `get_daily_snapshot()` - Get daily snapshot for many securities
+
+### Job Management
+
+- `create_bulk_securities_job()` - Create async job
+- `poll_job()` - Poll job until completion
+- `get_job_status()` - Get job status
+- `export_job_result()` - Export job result to file
+- `stream_job_result()` - Stream job result to file
+
+### Export Operations
+
+- `export_timeseries()` - Export timeseries to file
+
+### Metadata
+
+- `list_fields()` - List available fields
+- `list_intervals()` - List available intervals
+- `list_securities()` - List available securities
+
+## Examples
+
+See `examples/` directory for complete usage examples.
+
+## Requirements
+
+- Python 3.9+
+- httpx
+
+## Development
+
+```bash
+git clone https://gitlab.com/yourusername/vanda-api.git
+cd vanda-api
+python -m venv venv
+source venv/bin/activate
+pip install -e ".[dev]"
+pre-commit install
+pytest
+```
+
+## License
+
+MIT License - see LICENSE file for details.
+
+## Support
+
+For issues and questions, please open an issue on GitLab.

vanda_api-0.1.0/pyproject.toml

@@ -0,0 +1,117 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vanda-api"
+version = "0.1.0"
+description = "Official Python SDK for Vanda Analytics Data API"
+readme = "README.md"
+requires-python = ">=3.9"
+license = {text = "MIT"}
+authors = [
+    {name = "Jonathan Aina", email = "Jonathan.Aina@vanda.com"}
+]
+keywords = ["vanda", "analytics", "finance", "market-data", "retail-trading", "api"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Intended Audience :: Financial and Insurance Industry",
+    "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.27.0",
+]
+
+[project.optional-dependencies]
+pandas = ["pandas>=1.5.0"]
+dev = [
+    "pytest>=7.4.0",
+    "pytest-asyncio>=0.21.0",
+    "pytest-cov>=4.1.0",
+    "respx>=0.20.0",
+    "ruff>=0.1.0",
+    "black>=23.0.0",
+    "mypy>=1.5.0",
+    "pre-commit>=3.3.0",
+    "pandas-stubs>=2.0.0",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/yourusername/vanda-api"
+Documentation = "https://gitlab.com/yourusername/vanda-api#readme"
+Repository = "https://gitlab.com/yourusername/vanda-api"
+Issues = "https://gitlab.com/yourusername/vanda-api/-/issues"
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+    "/tests",
+    "/README.md",
+    "/LICENSE",
+    "/CHANGELOG.md",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/vanda"]
+
+[tool.black]
+line-length = 100
+target-version = ["py39", "py310", "py311", "py312"]
+include = '\\.pyi?$'
+
+[tool.ruff]
+line-length = 100
+target-version = "py39"
+select = [
+    "E",   # pycodestyle errors
+    "W",   # pycodestyle warnings
+    "F",   # pyflakes
+    "I",   # isort
+    "B",   # flake8-bugbear
+    "C4",  # flake8-comprehensions
+    "UP",  # pyupgrade
+]
+ignore = [
+    "E501",  # line too long (handled by black)
+]
+
+[tool.ruff.isort]
+known-first-party = ["vanda"]
+
+[tool.mypy]
+python_version = "3.9"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = true
+disallow_incomplete_defs = true
+check_untyped_defs = true
+disallow_untyped_decorators = false
+no_implicit_optional = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+warn_no_return = true
+strict_equality = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disallow_untyped_defs = false
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+addopts = "--cov=vanda --cov-report=term-missing --cov-report=xml"
+
+[tool.coverage.run]
+source = ["src"]
+omit = [
+    "*/tests/*",
+    "*/test_*.py",
+]
+disable_warnings = ["module-not-measured"]

vanda_api-0.1.0/src/vanda/__init__.py

@@ -0,0 +1,25 @@
+from vanda.async_client import AsyncVandaClient
+from vanda.client import VandaClient
+from vanda.errors import (
+    AuthError,
+    NotFoundError,
+    RateLimitError,
+    ServerError,
+    TransportError,
+    ValidationError,
+    VandaError,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "VandaClient",
+    "AsyncVandaClient",
+    "VandaError",
+    "AuthError",
+    "RateLimitError",
+    "NotFoundError",
+    "ValidationError",
+    "ServerError",
+    "TransportError",
+]