Skip to content

[P0] Analysis module documented in README but does not exist #9

@karlwaldman

Description

@karlwaldman

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 file

User 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() and spread() 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

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions