ARGUS is a Python-based market analytics project evolving from a small FX converter into a broader data-oriented platform for exchange rates, market data, analytics, dashboards, and future AI-assisted monitoring workflows.

ARGUS is currently focused on building a clean local foundation:

• currency conversion using live ExchangeRate API data
• historical market-data retrieval using yfinance
• calculator and conversion logic
• input validation and error handling
• Tkinter GUI prototype
• legacy CLI/debug interface
• pandas/matplotlib-based analytics prototype
• tests and documentation

This project is licensed under the Apache License 2.0.

ARGUS is designed to grow step by step from a local Python application into a market analytics and monitoring system.

The long-term direction includes:

• market data ingestion
• historical FX and market data analysis
• reusable analytics and metric layers
• dashboards and visualizations
• local and cloud-based storage
• data quality checks
• reporting workflows
• future AI-assisted research and agentic monitoring

The full project roadmap is maintained separately in docs/roadmap.md.

Each roadmap phase is treated as a separate development sprint. The roadmap describes how ARGUS is planned to grow from a local Python application into a broader market analytics, data engineering and future AI-assisted monitoring system.

• Calculator
• Currency conversion using live ExchangeRate API data
• Historical market-data retrieval using yfinance
• Input validation and error handling
• Tkinter GUI prototype
• Legacy CLI/debug interface
• Basic pandas-based trend metrics
• Matplotlib-based trend visualization
• Basic client, service and analytics pipeline
• Basic test suite

docs/
src/
  argus/
    analytics/
      charts/
      metrics/
    clients/
    domain/
    gui/
    services/
    config.py
    main.py
  legacy/
    cli/
tests/
pyproject.toml
README.md

• Python 3.11+

• requests
• python-dotenv
• yfinance
• pandas
• NumPy
• matplotlib
• Tkinter
• pytest

• ExchangeRate API for live currency conversion
• yfinance for historical market-data retrieval and analytics

ARGUS is expected to grow into a broader data and analytics system.

Planned or likely future technologies include:

• Frankfurter API for historical FX data
• possible additional market-data APIs later

• pandas
• NumPy
• possibly Polars later for larger datasets

• PostgreSQL
• DuckDB
• Parquet
• optional cloud storage

• matplotlib
• Plotly
• NiceGUI

• GitHub Actions
• Docker
• Docker Compose
• cloud deployment later

• Azure, GCP or AWS depending on project direction
• scheduled ingestion
• data quality checks
• reporting pipelines

• LLM-assisted summaries
• RAG over stored reports or notes
• agentic data checks
• anomaly monitoring
• human-in-the-loop signal review

Before running ARGUS locally, make sure you have:

• Python 3.11 or newer
• Git
• pip
• an ExchangeRate API key for live currency conversion. Historical analytics currently use yfinance and do not require an additional API key.

Recommended for development:

• VS Code
• a virtual environment
• pytest

Clone the repository:

git clone https://github.com/BytecodeBrewer/argus.git
cd argus

Create a virtual environment:

python -m venv .venv

Activate the virtual environment.

On Windows PowerShell:

.venv\Scripts\Activate.ps1

On macOS/Linux:

source .venv/bin/activate

Install the project in editable mode:

pip install -e .

For development and tests, install the development dependencies:

pip install -e ".[dev]"

ARGUS currently uses the ExchangeRate API for live currency conversion.

Create a free account at ExchangeRate API and generate your personal API key.

Create a file named .env in the project root:

.env

Add your API key:

EXCHANGE_RATE_API_KEY=your_api_key_here

The .env file must stay local and should never be committed.

Start the current Tkinter GUI:

python -m argus.main

This starts the local ARGUS prototype with calculator, currency conversion and basic analytics views.

The legacy CLI is still available for quick local checks and debugging:

python src/legacy/debug_main.py

Run the test suite:

pytest

More detailed project documentation lives in docs/.

Current documentation:

• docs/roadmap.md — sprint-based project roadmap
• docs/gui.md — notes about the current Tkinter GUI prototype
• metric and UI research notes for future analytics and interface decisions

ARGUS has completed its first foundation phase.

The project now has a runnable local Python application, a Tkinter GUI prototype, basic analytics, tests, documentation, CI checks and open-source readiness files.

Current focus:

• continue Sprint 2 — Market Analytics & Data Source Expansion
• extend historical market-data support beyond the first yfinance client
• add stronger market metrics
• expand pandas-based analytics workflows
• improve dashboard usefulness without adding unnecessary chart noise
• document metric definitions, assumptions and data-source behavior