Skip to content

Commit 92c8849

Browse files
tdobrowolski1claude
andcommitted
Add CI workflow, changelog, contributing guide, cross-links
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 4e3f2f9 commit 92c8849

4 files changed

Lines changed: 100 additions & 2 deletions

File tree

.github/workflows/ci.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: CI
2+
on:
3+
push:
4+
branches: [main]
5+
pull_request:
6+
branches: [main]
7+
jobs:
8+
test:
9+
runs-on: ubuntu-latest
10+
strategy:
11+
matrix:
12+
python-version: ["3.10", "3.11", "3.12", "3.13"]
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: actions/setup-python@v5
16+
with:
17+
python-version: ${{ matrix.python-version }}
18+
- run: pip install -e ".[dev]"
19+
- run: pytest tests/test_client.py -v

CHANGELOG.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Changelog
2+
3+
## 0.2.0 (2026-03-26)
4+
5+
### Added
6+
- `zero_dte()` — real-time 0DTE analytics (regime, pin risk, expected move, hedging, decay)
7+
- `exposure_history()` — daily exposure snapshots for trend analysis
8+
- `adv_volatility()` — advanced volatility analytics (SVI parameters, variance surface, arbitrage detection, greeks surfaces, variance swap pricing)
9+
- Comprehensive method reference table in README
10+
- SEO-optimized keywords in PyPI metadata
11+
12+
### Changed
13+
- Updated API plans table to reflect current tiers (Free/Basic/Growth/Alpha)
14+
- Improved README structure and documentation
15+
16+
## 0.1.0 (2026-03-13)
17+
18+
### Added
19+
- Initial release
20+
- Core client with all FlashAlpha API endpoints
21+
- Exposure analytics: `gex()`, `dex()`, `vex()`, `chex()`, `exposure_levels()`, `exposure_summary()`, `narrative()`
22+
- Market data: `stock_quote()`, `option_quote()`, `stock_summary()`, `surface()`
23+
- Historical data: `historical_stock_quote()`, `historical_option_quote()`
24+
- Pricing: `greeks()`, `iv()`, `kelly()`
25+
- Volatility: `volatility()`
26+
- Reference: `tickers()`, `options()`, `symbols()`, `account()`, `health()`
27+
- Error handling: `AuthenticationError`, `TierRestrictedError`, `NotFoundError`, `RateLimitError`, `ServerError`
28+
- 36 unit tests, 23 integration tests

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
Thanks for your interest in contributing to the FlashAlpha Python SDK.
4+
5+
## Reporting Issues
6+
7+
Open an issue on [GitHub](https://github.com/FlashAlpha-lab/flashalpha-python/issues) with:
8+
- Python version
9+
- SDK version (`flashalpha.__version__`)
10+
- Steps to reproduce
11+
- Expected vs actual behavior
12+
13+
## Development Setup
14+
15+
```bash
16+
git clone https://github.com/FlashAlpha-lab/flashalpha-python.git
17+
cd flashalpha-python
18+
pip install -e ".[dev]"
19+
pytest tests/test_client.py -v
20+
```
21+
22+
## Running Tests
23+
24+
Unit tests (no API key needed):
25+
```bash
26+
pytest tests/test_client.py -v
27+
```
28+
29+
Integration tests (requires API key):
30+
```bash
31+
FLASHALPHA_API_KEY=your_key pytest tests/test_integration.py -m integration -v
32+
```
33+
34+
## Pull Requests
35+
36+
1. Fork the repo
37+
2. Create a branch (`git checkout -b feature/your-feature`)
38+
3. Make your changes
39+
4. Add tests for new functionality
40+
5. Run the test suite
41+
6. Submit a PR
42+
43+
## Code Style
44+
45+
- Type hints on all public methods
46+
- Docstrings on all public methods
47+
- Follow existing patterns in `client.py`

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
[![PyPI](https://img.shields.io/pypi/v/flashalpha)](https://pypi.org/project/flashalpha/)
44
[![Python](https://img.shields.io/pypi/pyversions/flashalpha)](https://pypi.org/project/flashalpha/)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
6+
[![CI](https://github.com/FlashAlpha-lab/flashalpha-python/actions/workflows/ci.yml/badge.svg)](https://github.com/FlashAlpha-lab/flashalpha-python/actions/workflows/ci.yml)
67

78
**Python client for the FlashAlpha options analytics API.** Access real-time gamma exposure (GEX), delta exposure (DEX), vanna exposure (VEX), charm exposure (CHEX), 0DTE analytics, Black-Scholes greeks, implied volatility, volatility surfaces, dealer positioning, Kelly criterion sizing, and more — all from Python.
89

@@ -213,8 +214,11 @@ Get your API key at **[flashalpha.com](https://flashalpha.com)**
213214

214215
- [FlashAlpha](https://flashalpha.com) — API keys, docs, pricing
215216
- [API Documentation](https://flashalpha.com/docs)
216-
- [Examples](https://github.com/FlashAlpha-lab/flashalpha-examples)
217-
- [GEX Explained](https://github.com/FlashAlpha-lab/gex-explained)
217+
- [GEX Explained](https://github.com/FlashAlpha-lab/gex-explained) — gamma exposure theory and code
218+
- [0DTE Options Analytics](https://github.com/FlashAlpha-lab/0dte-options-analytics) — 0DTE pin risk, expected move, dealer hedging
219+
- [Volatility Surface Python](https://github.com/FlashAlpha-lab/volatility-surface-python) — SVI calibration, variance swap, skew analysis
220+
- [Examples](https://github.com/FlashAlpha-lab/flashalpha-examples) — runnable tutorials
221+
- [Awesome Options Analytics](https://github.com/FlashAlpha-lab/awesome-options-analytics) — curated resource list
218222

219223
## License
220224

0 commit comments

Comments
 (0)