stellar-stats 0.8.0__tar.gz

stellar_stats-0.8.0/.gitignore

@@ -0,0 +1,25 @@
+build/
+dist/
+result.*/
+*.pyc
+*.DS_Store
+.idea/
+.vscode/
+*.bak
+*.orig
+*.egg-info/
+*.ipynb
+.ipynb_checkpoints/
+.cache/
+*.log
+*.csv
+*.html
+*.png
+*.old
+*.json
+*.xlsx
+*.prof
+*.tmp
+*.pickle
+.pdm-python
+.python-version

stellar_stats-0.8.0/CLAUDE.md

@@ -0,0 +1,54 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+### Development
+- `stellar-stats run` - Run the Streamlit dashboard application
+- `stellar-stats gen-investors <account_name> --investor-name <name>` - Generate investors.csv from cashflow data
+- `pip install -e .` - Install package in development mode
+- `pip install -e .[dev]` - Install with development dependencies
+- `pip install -e .[test]` - Install with test dependencies
+
+### Package Management
+This project uses pip with pyproject.toml configuration. No package.json or specific test commands are defined.
+
+## Architecture
+
+This is a Streamlit-based trading statistics dashboard that analyzes backtest and live trading performance.
+
+### Core Components
+- **app.py** - Main Streamlit application with dashboard UI and data visualization
+- **cli.py** - Command-line interface using Click, wraps Streamlit execution
+- **data.py** - Data loading functions for returns, trades, round trips, slippage, and benchmarks
+- **config.py** - Configuration management via TOML files, API setup (Tushare, yfinance)
+- **ui.py** - UI components and plotting functions for performance visualization
+- **auth.py** - Authentication setup for the dashboard
+- **utils.py** - Utility functions including cache management
+- **stats.py** - Statistical analysis functions and performance metrics calculations
+- **roundtrip.py** - Round-trip analysis and trade extraction functions
+
+### Data Sources
+- Local CSV/HDF/Parquet files containing returns, trades, round trips, slippage data
+- Remote data via yfinance for benchmark symbols
+- Tushare API for Chinese market indices (requires token in config.toml)
+- Optional investors.csv for investor-specific performance tracking
+
+### Key Features
+- Multi-account performance analysis and comparison
+- Benchmark comparison with leverage options
+- Period selection (YTD, inception, custom ranges)
+- Performance metrics, drawdown analysis, return distributions
+- Trade analysis including underlying breakdowns and slippage tracking
+- Round-trip trade analysis and extraction capabilities
+- Investor-specific return calculations when investors.csv exists
+- Automated investor data generation from cashflow data
+
+### Configuration
+- Optional config.toml file defines accounts and data directories
+- Falls back to auto-discovery of directories for account data
+- Supports custom benchmark symbols and API tokens
+
+### Dependencies
+Uses specialized financial libraries: empyrical-reloaded for performance metrics, with local implementations for trade analysis functions. Additional dependencies include streamlit, plotly, click, yfinance, tushare, tomlkit, tabulate, numpy, pandas, extra-streamlit-components, st-annotated-text, and watchdog for enhanced functionality.

stellar_stats-0.8.0/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: stellar-stats
+Version: 0.8.0
+Summary: Stats page for backtest/live trading
+Author-email: Keli Hu <dev@keli.hu>
+License: MIT
+Project-URL: Homepage, https://github.com/keli/stellar-stats
+Keywords: trade stats
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: click
+Requires-Dist: tabulate
+Requires-Dist: empyrical-reloaded
+Requires-Dist: extra-streamlit-components
+Requires-Dist: plotly
+Requires-Dist: st-annotated-text
+Requires-Dist: streamlit>=1.39.0
+Requires-Dist: tomlkit
+Requires-Dist: tushare
+Requires-Dist: watchdog
+Requires-Dist: yfinance>=0.2.51
+
+# Stellar Stats
+
+A Streamlit-based trading statistics dashboard that analyzes backtest and live trading performance with comprehensive metrics and visualizations.
+
+## Features
+
+- **Multi-account performance analysis** - Compare performance across different trading accounts
+- **Benchmark comparison** - Compare against market indices with leverage options
+- **Flexible time periods** - YTD, inception-to-date, or custom date ranges
+- **Comprehensive metrics** - Performance metrics, drawdown analysis, return distributions
+- **Trade analysis** - Detailed breakdowns by underlying assets and slippage tracking
+- **Round-trip analysis** - Extract and analyze complete trading round-trips
+- **Investor tracking** - Calculate investor-specific returns
+
+## Installation
+
+```bash
+pip install stellar-stats
+```
+
+
+## Usage
+
+### Run the Dashboard
+
+```bash
+stellar-stats run
+```
+
+This launches the Streamlit web interface for interactive analysis.
+
+
+## Configuration
+
+Create an optional `config.toml` file to define:
+
+- Account configurations and data directories
+- Custom benchmark symbols
+- API tokens (Tushare for Chinese market data)
+
+The system will auto-discover account directories if no configuration is provided, which is useful for viewing backtesting results.
+
+## Data Sources
+
+- **Local files**: CSV/HDF/Parquet files containing returns, trades, round trips, and slippage data
+- **Market data**: yfinance for global benchmark symbols
+- **Chinese markets**: Tushare API (requires token configuration)
+- **Investor data**: Optional investors.csv for investor-specific analysis
+
+
+## License
+
+MIT
+

stellar_stats-0.8.0/README.md

@@ -0,0 +1,54 @@
+# Stellar Stats
+
+A Streamlit-based trading statistics dashboard that analyzes backtest and live trading performance with comprehensive metrics and visualizations.
+
+## Features
+
+- **Multi-account performance analysis** - Compare performance across different trading accounts
+- **Benchmark comparison** - Compare against market indices with leverage options
+- **Flexible time periods** - YTD, inception-to-date, or custom date ranges
+- **Comprehensive metrics** - Performance metrics, drawdown analysis, return distributions
+- **Trade analysis** - Detailed breakdowns by underlying assets and slippage tracking
+- **Round-trip analysis** - Extract and analyze complete trading round-trips
+- **Investor tracking** - Calculate investor-specific returns
+
+## Installation
+
+```bash
+pip install stellar-stats
+```
+
+
+## Usage
+
+### Run the Dashboard
+
+```bash
+stellar-stats run
+```
+
+This launches the Streamlit web interface for interactive analysis.
+
+
+## Configuration
+
+Create an optional `config.toml` file to define:
+
+- Account configurations and data directories
+- Custom benchmark symbols
+- API tokens (Tushare for Chinese market data)
+
+The system will auto-discover account directories if no configuration is provided, which is useful for viewing backtesting results.
+
+## Data Sources
+
+- **Local files**: CSV/HDF/Parquet files containing returns, trades, round trips, and slippage data
+- **Market data**: yfinance for global benchmark symbols
+- **Chinese markets**: Tushare API (requires token configuration)
+- **Investor data**: Optional investors.csv for investor-specific analysis
+
+
+## License
+
+MIT
+

stellar_stats-0.8.0/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=45", "wheel", "setuptools_scm[toml]>=6.2"]
+build-backend = "setuptools.build_meta"
+
+[project]
+dependencies = [
+    "click",
+    "tabulate",
+    "empyrical-reloaded",
+    "extra-streamlit-components",
+    "plotly",
+    "st-annotated-text",
+    "streamlit>=1.39.0",
+    "tomlkit",
+    "tushare",
+    "watchdog",
+    "yfinance>=0.2.51",
+]
+name = "stellar-stats"
+dynamic = ["version"]
+description = "Stats page for backtest/live trading"
+authors = [
+    {name = "Keli Hu", email = "dev@keli.hu"},
+]
+requires-python = ">=3.9"
+readme = "README.md"
+license = {text = "MIT"}
+keywords = ["trade stats"]
+
+[project.urls]
+Homepage = "https://github.com/keli/stellar-stats"
+
+[project.scripts]
+stellar-stats = "stellar_stats.cli:main"
+
+[tool.setuptools]
+packages = ["stellar_stats"]
+package-dir = { "stellar_stats" = "src/stellar_stats" }
+
+[tool.setuptools_scm]
+local_scheme = 'no-local-version'
+version_scheme = "post-release"
+
+[tool.setuptools.dynamic]
+version = { attr = "setuptools_scm.get_version" }

stellar_stats-0.8.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+