learnstat 0.2.0__tar.gz → 0.2.2__tar.gz

{learnstat-0.2.0 → learnstat-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: learnstat
-Version: 0.2.0
+Version: 0.2.2
 Summary: An AI-assisted learning companion for statistical analysis with pandas, NumPy, SciPy and Matplotlib.
 License: MIT
 Project-URL: Homepage, https://github.com/umorfaruksupto/leanstat
@@ -11,6 +11,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pandas>=2.0
 Requires-Dist: numpy>=1.24
+Requires-Dist: openpyxl>=3.1
 Provides-Extra: viz
 Requires-Dist: matplotlib>=3.7; extra == "viz"
 Provides-Extra: stats
@@ -54,6 +55,28 @@ pip install -e ".[all]"        # pandas, numpy, matplotlib, scipy, ipython
 pip install -e .               # core only: profiling, rules, recovery
 ```
 
+### Quick start
+
+```bash
+pip install learnstat
+learnstat
+```
+
+1. Choose your AI company, paste the key, pick a model. learnstat tests it and says OK or what is wrong (optional; skip it and everything works offline).
+2. Press Enter to pick your CSV or Excel file in a normal window.
+3. You are at a Python prompt with `df`, `pd` (pandas) and `np` (NumPy) ready. Write ordinary pandas / NumPy code:
+
+```
+>>> df.groupby("country")["income"].mean()
+>>> np.log(df["income"]).describe()
+```
+
+learnstat suggests better statistics and charts as you go, and explains and fixes simple mistakes. Type `/help` for the shortcuts, or `menu` for a one-line menu:
+
+```
+1 summary | 2 ask AI | 3 check script | 4 run script | 5 code | 6 learn | 7 load data | 8 AI | ? help | q quit
+```
+
 ### Add an AI (optional)
 
 Just run `learnstat`. If no AI is set up yet it offers a guided setup, and you can repeat it any time with `learnstat setup` (or `/ai` inside a session):
@@ -177,6 +200,7 @@ learnstat/
   config.py       saved AI accounts: provider, api_key, base_url, model
   providers.py    presets for the AI companies
   setup.py        guided terminal setup (company -> key -> model -> check)
+  guide.py        the numbered home menu students use
   session.py      ties it together; read_csv/track/check/run
   commands.py     slash commands
   ipython_ext.py  %load_ext learnstat

{learnstat-0.2.0 → learnstat-0.2.2}/README.md

@@ -24,6 +24,28 @@ pip install -e ".[all]"        # pandas, numpy, matplotlib, scipy, ipython
 pip install -e .               # core only: profiling, rules, recovery
 ```
 
+### Quick start
+
+```bash
+pip install learnstat
+learnstat
+```
+
+1. Choose your AI company, paste the key, pick a model. learnstat tests it and says OK or what is wrong (optional; skip it and everything works offline).
+2. Press Enter to pick your CSV or Excel file in a normal window.
+3. You are at a Python prompt with `df`, `pd` (pandas) and `np` (NumPy) ready. Write ordinary pandas / NumPy code:
+
+```
+>>> df.groupby("country")["income"].mean()
+>>> np.log(df["income"]).describe()
+```
+
+learnstat suggests better statistics and charts as you go, and explains and fixes simple mistakes. Type `/help` for the shortcuts, or `menu` for a one-line menu:
+
+```
+1 summary | 2 ask AI | 3 check script | 4 run script | 5 code | 6 learn | 7 load data | 8 AI | ? help | q quit
+```
+
 ### Add an AI (optional)
 
 Just run `learnstat`. If no AI is set up yet it offers a guided setup, and you can repeat it any time with `learnstat setup` (or `/ai` inside a session):
@@ -147,6 +169,7 @@ learnstat/
   config.py       saved AI accounts: provider, api_key, base_url, model
   providers.py    presets for the AI companies
   setup.py        guided terminal setup (company -> key -> model -> check)
+  guide.py        the numbered home menu students use
   session.py      ties it together; read_csv/track/check/run
   commands.py     slash commands
   ipython_ext.py  %load_ext learnstat

{learnstat-0.2.0 → learnstat-0.2.2}/learnstat/__init__.py

@@ -21,7 +21,7 @@ from .recovery import Executor, RunResult
 from .session import Session, get_session, set_session
 from .suggestions import Suggestion
 
-__version__ = "0.2.0"
+__version__ = "0.2.2"
 
 
 def read_csv(path, name: str | None = None, **kwargs):