https://github.com/connorodea/statistics-toolkit-cli
๐ A comprehensive command-line statistics learning tool with step-by-step explanations
https://github.com/connorodea/statistics-toolkit-cli
cli edtech education learning mathematics python statistics
Last synced: 5 months ago
JSON representation
๐ A comprehensive command-line statistics learning tool with step-by-step explanations
- Host: GitHub
- URL: https://github.com/connorodea/statistics-toolkit-cli
- Owner: connorodea
- License: mit
- Created: 2025-08-22T21:54:22.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-08-22T21:58:11.000Z (10 months ago)
- Last Synced: 2025-09-25T08:57:39.105Z (9 months ago)
- Topics: cli, edtech, education, learning, mathematics, python, statistics
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Statistics Toolkit CLI ๐
> A comprehensive command-line statistics learning and analysis tool with step-by-step explanations
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/MIT)
[](https://github.com/connorodea/statistics-toolkit-cli/issues)
## ๐ฏ Overview
Transform your terminal into a comprehensive statistics education platform! This toolkit provides step-by-step explanations for statistical concepts, making it perfect for students, educators, and anyone who wants to understand the "why" behind statistical calculations.
## โจ Features
- **๐ Descriptive Statistics**: Mean, median, mode, variance, standard deviation, five-number summary, outlier detection
- **๐งช Hypothesis Testing**: One-sample and two-sample t-tests with complete explanations
- **๐ Data Visualization**: Histograms, box plots, scatter plots with statistical overlays
- **๐พ Data Management**: CSV import/export, save/load datasets
- **๐ Educational Focus**: Every calculation shows mathematical steps and reasoning
- **๐ฅ๏ธ Interactive CLI**: User-friendly menu-driven interface
## ๐ Quick Start
### Installation
```bash
# Clone the repository
git clone https://github.com/connorodea/statistics-toolkit-cli.git
cd statistics-toolkit-cli
# Install dependencies
pip install -r requirements.txt
# Run the toolkit
python stats_cli.py
```
### One-Line Setup
```bash
curl -sSL https://raw.githubusercontent.com/connorodea/statistics-toolkit-cli/main/setup_stats_toolkit.sh | bash
```
## ๐ Usage Examples
### Interactive Menu
```bash
python stats_cli.py
```
### Sample Data Demo
```bash
python stats_cli.py --demo
```
### Quick Analysis
```
Enter values: 85 92 78 88 95 82 79 91 87 84
=== MEASURES OF CENTER ===
Sample size: n = 10
MEAN CALCULATION:
xฬ = ฮฃx/n = 861/10 = 86.1000
MEDIAN CALCULATION:
Sorted data: [78 79 82 84 85 87 88 91 92 95]
n is even: median = (85 + 87)/2 = 86.0000
```
## ๐ Educational Philosophy
This toolkit is designed for **learning statistics**, not just computing answers. Every calculation shows:
- ๐ **The formula being used**
- ๐ข **Step-by-step substitution of values**
- ๐ **Intermediate calculations**
- ๐ก **Interpretation of results**
- โ
**Assumption checking**
## ๐ Project Structure
```
statistics-toolkit-cli/
โโโ stats_cli.py # Main application
โโโ requirements.txt # Python dependencies
โโโ setup.py # Package installation
โโโ Makefile # Development commands
โโโ examples/
โ โโโ data/ # Sample CSV datasets
โ โโโ create_sample_data.py # Generate sample data
โโโ tests/
โ โโโ test_basic.py # Unit tests
โโโ docs/ # Documentation
```
## ๐ ๏ธ Development
### Setup Development Environment
```bash
# Clone and setup
git clone https://github.com/connorodea/statistics-toolkit-cli.git
cd statistics-toolkit-cli
# Create virtual environment
python3 -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt
# Install as editable package
pip install -e .
```
### Available Commands
```bash
make run # Run the CLI tool
make demo # Run sample data demo
make test # Run tests
make sample-data # Generate sample datasets
make clean # Clean build artifacts
make help # Show all commands
```
### Running Tests
```bash
python -m pytest tests/ -v
# or
make test
```
## ๐ Sample Datasets
The toolkit includes sample datasets for practice:
- **`test_scores.csv`** - Student academic performance data
- **`sales_data.csv`** - Business sales and advertising data
- **`study_vs_scores.csv`** - Study time vs exam performance
Generate fresh sample data:
```bash
make sample-data
```
## ๐ค Contributing
Contributions are welcome! Here's how to get started:
1. **Fork the repository**
2. **Create a feature branch**: `git checkout -b feature/amazing-feature`
3. **Make your changes**
4. **Add tests** for new functionality
5. **Run tests**: `make test`
6. **Commit your changes**: `git commit -m 'Add amazing feature'`
7. **Push to the branch**: `git push origin feature/amazing-feature`
8. **Open a Pull Request**
### Development Guidelines
- Follow PEP 8 style guidelines
- Add docstrings to new functions
- Include tests for new features
- Update README if adding major features
- Maintain the educational focus of explanations
## ๐ Issues & Support
- **Bug Reports**: [Create an issue](https://github.com/connorodea/statistics-toolkit-cli/issues/new?template=bug_report.md)
- **Feature Requests**: [Create an issue](https://github.com/connorodea/statistics-toolkit-cli/issues/new?template=feature_request.md)
- **Questions**: [Start a discussion](https://github.com/connorodea/statistics-toolkit-cli/discussions)
## ๐ Documentation
- [Installation Guide](docs/installation.md)
- [User Manual](docs/user_manual.md)
- [Developer Guide](docs/developer_guide.md)
- [API Reference](docs/api_reference.md)
## ๐ Inspiration
Originally inspired by TI-84 calculator programs, this toolkit brings the same step-by-step educational approach to modern Python development, making statistics accessible and understandable for everyone.
## ๐ License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## ๐ Acknowledgments
- Built for statistics education and learning
- Inspired by the need for transparent statistical calculations
- Designed to complement traditional statistics textbooks and courses
---
**Made with โค๏ธ for statistics education**
[](https://github.com/connorodea/statistics-toolkit-cli/stargazers)
[](https://github.com/connorodea/statistics-toolkit-cli/network/members)