Skip to main content

A stock market analysis and visualization Python package.

Project description

Flux-RX

High-Performance Financial Engineering & Analytics Framework

Flux-RX is an advanced, institutional-grade Python framework designed for rapid financial data analysis, portfolio optimization, and beautifully rendered interactive dashboards. Replacing disjointed scripts with a cohesive system, Flux-RX implements strict typing, rigorous error handling, and a sophisticated terminal UI.


Capabilities

  • Robust Data Ingestion: High-speed, cached acquisition of market data and metadata via Yahoo Finance.
  • Deep Analytics Engine: Compute comprehensive metrics including CAGR, Volatility, Sharpe Ratio, Maximum Drawdown, Value at Risk (VaR), Conditional VaR, Information Ratio, Tracking Error, Hurst Exponent, and Z-Scores.
  • Terminal Interface: A best-in-class CLI built on rich that renders stunning, color-coded tables for metrics, screening, and optimization natively in the console.
  • Dynamic Dashboard: A fully responsive, sidebar-navigation local web application (dash-bootstrap-components) for profound visual analysis.
  • Hyper-Professional Layouts: Native support for "Obsidian", "Terminal", "Monochrome", and "Light Pro" themes. Strictly adhering to institutional aesthetics (no emojis, no purple elements).
  • Portfolio Architecture: Conduct Modern Portfolio Theory (MPT) optimization targeting Maximum Sharpe, Minimum Volatility, or Maximum Return.

Installation

Ensure you have Python 3.10+ installed.

# Clone the repository
git clone https://github.com/your-org/flux-rx.git
cd flux-rx

# Install via setup.py (or pip)
pip install -e .

Note: For development capabilities (like mypy and pytest), install with pip install -e .[dev].

Command-Line Interface

The flux-rx command serves as your entry point to all operations.

Quick Metrics

Extract fundamental metrics and calculate ratios instantly.

flux-rx metrics AAPL --period 5y

Portfolio Screener

Compare, rank, and evaluate multiple assets simultaneously.

flux-rx screen AAPL MSFT GOOGL NVDA TSLA --sort sharpe_ratio

Modern Portfolio Optimization

Calculate the optimal weightings for a basket of assets.

flux-rx optimize AAPL MSFT GOOGL --objective sharpe

Static Reporting & Export

Generate a sleek static HTML report or export raw data to your preferred format.

# Generate interactive HTML report
flux-rx report AAPL --period max --theme obsidian

# Export to CSV/JSON/Excel
flux-rx export AAPL --format csv --path my_data.csv

Interactive Dashboard

Launch the heavy-duty analytical terminal in your browser.

flux-rx dashboard --port 8050

System Architecture

Flux-RX v2.0 introduces several architectural upgrades:

  • flux_rx.exceptions: A custom exception hierarchy (FluxDataError, FluxComputeError, etc.) ensuring graceful failure states without arbitrary Python stack traces.
  • flux_rx.logger: Structured, console-agnostic logging powered by rich, replacing arbitrary print statements.
  • flux_rx.analytics: Hardened numerical methods with explicit input validation on raw price vectors.

License

MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flux_rx-1.0.0.tar.gz (35.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flux_rx-1.0.0-py3-none-any.whl (39.6 kB view details)

Uploaded Python 3

File details

Details for the file flux_rx-1.0.0.tar.gz.

File metadata

  • Download URL: flux_rx-1.0.0.tar.gz
  • Upload date:
  • Size: 35.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flux_rx-1.0.0.tar.gz
Algorithm Hash digest
SHA256 a34bd91d2c5471befc9acdb2cb654ce613e05a8b845a0cff14e28f8bbaf0f5fd
MD5 b62bb8d9602c1b113dbb0217d24d8cc8
BLAKE2b-256 0c5ea89c999461aa1c04cf5f624f2fb79208cef3b07d274eca8ed0c7678b53e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for flux_rx-1.0.0.tar.gz:

Publisher: publish.yml on desenyon/flux-rx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flux_rx-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: flux_rx-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 39.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for flux_rx-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fb7938fbaedb7d9b4111c511a5f4183b7865833b4631fc0d649b5ace6ca2f4fb
MD5 0d5567b5f3236b7075fec1b2e655a297
BLAKE2b-256 f2eeded3ac57bb27cc739f9319725d351734fc39e96a1d71b1bcfc872e1561f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for flux_rx-1.0.0-py3-none-any.whl:

Publisher: publish.yml on desenyon/flux-rx

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page