openstat-cli 1.0.0__tar.gz

openstat_cli-1.0.0/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests with coverage
+        run: pytest tests/ -v --tb=short --cov=openstat --cov-report=term-missing --cov-fail-under=75
+
+      - name: Run demo script
+        run: python -m openstat run examples/demo.ost
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]" ruff
+
+      - name: Ruff check
+        run: ruff check src/ tests/

openstat_cli-1.0.0/.gitignore

@@ -0,0 +1,40 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info/
+*.egg
+dist/
+build/
+*.whl
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Ruff
+.ruff_cache/
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Outputs (generated by running OpenStat)
+outputs/
+
+# Claude Code
+.claude/

openstat_cli-1.0.0/CHANGELOG.md

@@ -0,0 +1,133 @@
+# Changelog
+
+All notable changes to OpenStat are documented here.
+
+Format follows [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+Versioning follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.9.0] – 2025-05-01
+
+### Added
+- **Post-hoc tests** (`posthoc`): Tukey HSD, Bonferroni, Scheffé pairwise comparisons after ANOVA
+- **Coefficient plot** (`plot coef`): horizontal error-bar plot of regression coefficients with 95% CI
+- **Marginal effects plot** (`plot margins`): visualise marginal effects after `margins`
+- **Interaction plot** (`plot interaction <y> <x> <moderator>`): shows regression lines by ±1 SD groups of the moderator
+- **Real-time session log** (`log using <path>`): streams every command and its output to a file
+- **Script runner enhancements**: `foreach`, `forvalues`, `if/else` blocks with variable substitution (`{var}`)
+- **Database connectivity** (`sqlload`): load data directly from SQL databases via connection URL (requires `connectorx`)
+- **SEM / CFA** (`sem`, `cfa`): structural equation modelling and confirmatory factor analysis via semopy
+- **Meta-analysis** (`meta`): fixed-effects (inverse-variance) and random-effects (DerSimonian-Laird), forest and funnel plots
+- **Network analysis** (`network`): build, describe, centrality, community detection, and plotting via networkx
+- **Auto model selection** (`automodel`): exhaustive subset search (≤8 predictors) or forward stepwise, ranked by AIC/BIC
+- **IPTW** (`iptw`): inverse probability of treatment weighting for causal inference; ATE/ATT; covariate balance table
+- **Reproducibility** (`session info/save/replay`, `set seed`, `version`): full session management and script replay
+- **TUI Dashboard** (`dashboard`): full-screen terminal UI with dataset overview, variable table, model results, and history (requires `textual`)
+- **PyPI packaging**: `pyproject.toml` polished for release; new extras `database`, `sem`, `network`, `tui`
+
+### Changed
+- `export docx` now includes a Summary Statistics table (N, Mean, SD, Min–Max per numeric column)
+- `set` command extended with `set seed <N>` sub-command
+- `log` command moved from `report_cmds` to `outreg_cmds` and upgraded to real-time streaming
+
+### Fixed
+- `plot coef` crash when `params` is a numpy array (not a pandas Series)
+- `} else {` block parsing in script runner
+- `automodel` formula normalisation (space-separated predictors now work)
+- `semopy.Model` API: `obj=` parameter goes in `fit()`, not `__init__()`
+- Duplicate command registration for `set` and `log`
+
+---
+
+## [0.8.0] – 2025-03-01
+
+### Added
+- **Bayesian inference** (`bayes`): MCMC sampling, posterior summaries, trace/posterior plots
+- **ARCH/GARCH** (`arch`, `garch`): volatility modelling for financial time series
+- **MANOVA** (`manova`): multivariate analysis of variance
+- **Clustering** (`cluster kmeans`, `cluster hclust`, `discriminant`): k-means, hierarchical, LDA/QDA
+- **Advanced ML** (`randomforest`, `gradientboost`, `neuralnet`, `svm`, `knn`): ensemble and deep learning models
+- **Influence diagnostics** (`influence`): Cook's distance, DFFITS, leverage plots
+- **Advanced regression** (`quantreg`, `truncreg`, `intreg`, `heckman`): quantile, truncated, interval, and selection models
+- **Advanced time series** (`vecm`, `var`, `granger`, `threshold`): VAR, VECM, Granger causality, threshold models
+- **Epidemiology** (`epi`): risk ratios, odds ratios, attributable risk, Mantel-Haenszel pooling
+- **Equivalence testing** (`equiv`, `tobit`): TOST and Tobit censored regression
+- **String commands** (`strreplace`, `strsplit`, `strextract`, `strpad`, `strcat`): column string manipulation
+- **DSL / macro system** (`define`, `macro`, `eval`): variable macros and expressions
+- **Resampling** (`bootstrap`, `jackknife`, `permtest`): resampling-based inference
+- **Model evaluation** (`roc`, `calibration`, `confusion`): classification diagnostics
+- **Data quality** (`missing`, `duplicates`, `outlier`, `assert`): profiling and validation
+- **Reshape** (`reshape wide`, `reshape long`, `pivot`, `unpivot`): data reshaping
+- **esttab** (`esttab`): publication-quality coefficient tables (LaTeX, HTML, Markdown)
+- **outreg2** (`outreg2`): Word/RTF-compatible regression tables
+- **Visualisation extras** (`plot violin`, `plot pairplot`, `plot parallel`, `plot density`): additional plot types
+
+### Changed
+- Session now tracks `_last_fit_result` and `_last_fit_kwargs` for bootstrap/esttab integration
+
+---
+
+## [0.7.0] – 2025-01-01
+
+### Added
+- **Survey analysis** (`svyset`, `svy: mean`, `svy: total`, `svy: proportion`, `svy: reg`): complex survey design
+- **Multiple imputation** (`mi impute`, `mi estimate`): MICE-based imputation with pooled estimates
+- **DuckDB backend** (`set backend duckdb`, `sql`): fast in-memory SQL on datasets
+- **Web API** (`openstat web`): FastAPI + WebSocket server for browser-based access
+- **Jupyter magic** (`%openstat`): run OpenStat commands in Jupyter notebooks
+- **Plugin system** (`plugin load/list/unload`): third-party command packages
+
+---
+
+## [0.6.0] – 2024-11-01
+
+### Added
+- **Power analysis** (`power`): t-test, ANOVA, chi-square, proportion power and sample size
+- **Factor analysis** (`factor`, `pca`, `rotate`): EFA, PCA, varimax/oblimin rotation
+- **IV regression** (`ivregress`): two-stage least squares
+- **Mixed models** (`mixed`): linear mixed-effects models via statsmodels
+- **Panel data** (`xtset`, `xtreg`, `xttest`, `hausman`): fixed/random effects, Hausman test
+
+---
+
+## [0.5.0] – 2024-09-01
+
+### Added
+- **Survival analysis** (`stset`, `sts graph`, `stcox`, `streg`, `stsum`): Kaplan-Meier, Cox PH, AFT
+- **Time series** (`tsset`, `arima`, `ardl`, `adf`, `kpss`, `forecast`): ARIMA, ARDL, unit-root tests
+- **Causal inference** (`pscore`, `teffects`, `did`, `rddesign`, `synth`): propensity score, DiD, RD
+- **Discrete choice** (`logit`, `probit`, `ologit`, `oprobit`, `mlogit`, `clogit`): limited dependent variable models
+- **Undo/redo** (`undo`, `redo`): step-back for data transformations
+
+---
+
+## [0.4.0] – 2024-07-01
+
+### Added
+- **Non-parametric tests** (`kruskal`, `mannwhitney`, `wilcoxon`, `friedman`, `spearman`): rank-based inference
+- **Report generation** (`report html`, `report latex`): automated analysis reports
+- **Plot diagnostics** (`plot diagnostics`): residuals vs fitted, Q-Q, scale-location
+
+---
+
+## [0.3.0] – 2024-05-01
+
+### Added
+- **Data management** (`load`, `save`, `drop`, `keep`, `rename`, `encode`, `decode`, `generate`, `replace`, `sort`, `merge`, `append`, `sample`, `undo`)
+- **Descriptive statistics** (`describe`, `summarize`, `tabulate`, `correlate`, `crosstab`, `anova`)
+- **Regression** (`ols`, `logit`, `poisson`, `margins`, `predict`, `test`)
+- **Plots** (`plot hist`, `plot scatter`, `plot line`, `plot box`, `plot bar`, `plot heatmap`, `plot acf`, `plot pacf`)
+- **Output** (`export docx`, `export pptx`)
+- **Configuration** (`config show`, `config set`)
+- **Script runner** (`run <script.ost>`): execute .ost script files
+- Interactive REPL with tab completion, syntax highlighting, and command history
+
+---
+
+## [0.1.0] – 2024-01-01
+
+### Added
+- Initial project scaffold
+- Basic REPL infrastructure
+- Polars DataFrame backend

openstat_cli-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,116 @@
+# Contributing to OpenStat
+
+Thanks for your interest in contributing! OpenStat is an open-source statistical analysis tool and we welcome contributions of all kinds.
+
+## Getting Started
+
+```bash
+# Clone the repo
+git clone https://github.com/YOUR_USERNAME/openstat.git
+cd openstat
+
+# Create a virtual environment
+python -m venv .venv
+source .venv/bin/activate  # or .venv\Scripts\activate on Windows
+
+# Install in editable mode with dev deps
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+```
+
+## Project Structure
+
+```
+src/openstat/
+├── cli.py              # Typer CLI entry point
+├── repl.py             # Interactive REPL with tab completion
+├── session.py          # Session state, undo system
+├── commands/
+│   ├── base.py         # @command decorator, registry
+│   ├── data_cmds.py    # load, filter, select, derive, sort, ...
+│   ├── stat_cmds.py    # summarize, tabulate, corr, ols, logit, ...
+│   ├── plot_cmds.py    # plot hist/scatter/line/box
+│   └── report_cmds.py  # report, help
+├── dsl/
+│   ├── tokenizer.py    # Safe expression tokenizer
+│   └── parser.py       # Recursive descent parser (no eval!)
+├── stats/
+│   └── models.py       # OLS, Logit via statsmodels
+├── plots/
+│   └── plotter.py      # matplotlib chart generation
+├── io/
+│   └── loader.py       # CSV, Parquet, DTA, Excel loaders
+└── reporting/
+    └── report.py       # Markdown report generator
+```
+
+## Adding a New Command
+
+1. Pick the right module in `src/openstat/commands/` (or create a new one).
+2. Use the `@command` decorator:
+
+```python
+from openstat.commands.base import command
+
+@command("mycommand", usage="mycommand <arg>")
+def cmd_mycommand(session, args):
+    """One-line description shown in help."""
+    df = session.require_data()
+    # ... your logic ...
+    return "Result text shown to user"
+```
+
+3. If you created a new module, import it in `src/openstat/commands/__init__.py`.
+4. Add tests in `tests/`.
+
+## Adding a DSL Function
+
+To add a new function to the expression language (used by `filter` and `derive`):
+
+1. Edit `src/openstat/dsl/parser.py`
+2. Add a case in `_apply_function()`
+3. Add a test in `tests/test_parser.py`
+
+## Guidelines
+
+- **No `eval()`** — all user expressions go through the safe parser
+- **Snapshot before mutation** — call `session.snapshot()` before modifying `session.df`
+- **Return strings** — command handlers return plain text (use `rich_to_str()` for Rich tables)
+- **Friendly errors** — use `friendly_error()` to wrap exceptions
+- **Test real values** — assert on actual numbers, not just "contains some string"
+
+## Running Tests
+
+```bash
+# Full suite
+pytest
+
+# Verbose with specific file
+pytest tests/test_commands.py -v
+
+# With coverage
+pytest --cov=openstat --cov-report=term-missing
+```
+
+## Code Style
+
+We use [ruff](https://docs.astral.sh/ruff/) for linting. Before submitting:
+
+```bash
+pip install ruff
+ruff check src/ tests/
+```
+
+## Pull Request Process
+
+1. Fork the repo and create a feature branch
+2. Write tests for your changes
+3. Ensure all tests pass (`pytest`)
+4. Run `ruff check` with no errors
+5. Submit a PR with a clear description of what and why
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

openstat_cli-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OpenStat Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.