-
Notifications
You must be signed in to change notification settings - Fork 0
Closed
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation
Description
Analysis Module Doesn't Exist
Priority: P0 - CRITICAL
Component: Python SDK
Found In: README.md lines 59-67
Problem
The README documents an analysis module with methods for technical indicators and spread analysis, but this module does not exist in the codebase.
Expected Behavior (According to README)
# Add technical indicators
df = client.analysis.with_indicators(
df,
indicators=["sma_20", "sma_50", "rsi", "bollinger_bands"]
)
# Calculate spread between Brent and WTI
spread = client.analysis.spread("BRENT_CRUDE_USD", "WTI_USD", start="2024-01-01")Actual Behavior
$ python3 -c "from oilpriceapi import OilPriceAPI; c = OilPriceAPI(); c.analysis"
AttributeError: 'OilPriceAPI' object has no attribute 'analysis'Evidence
File structure shows no analysis module:
$ ls oilpriceapi/
__init__.py async_client.py client.py exceptions.py models.py resources/ retry.py visualization.py
# No analysis.py fileUser Impact
- Users following README will get
AttributeError - SDK appears broken to new users
- Damages trust and credibility
Suggested Fix
Option 1 (Recommended): Remove from README until implemented
- Delete lines 59-67 from README.md
- Add to roadmap if planned for future
Option 2: Implement the module
- Create
oilpriceapi/analysis.py - Implement
with_indicators()andspread()methods - Add proper tests
Audit Source
Found during Week 3 Documentation Alignment audit (December 16, 2025)
See: PYTHON_SDK_AUDIT_REPORT.md
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't workingdocumentationImprovements or additions to documentationImprovements or additions to documentation