Metadata-Version: 2.4
Name: 1cijferho
Version: 0.1.0
Summary: Professional tools for processing Dutch higher educational data (1CijferHO / ROD)
Project-URL: Homepage, https://github.com/cedanl/1cijferho
Project-URL: Repository, https://github.com/cedanl/1cijferho.git
Project-URL: Issues, https://github.com/cedanl/1cijferho/issues
License: MIT
Keywords: data-processing,duo,education,higher-education,netherlands
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Education
Requires-Python: >=3.13
Requires-Dist: fastexcel>=0.12.1
Requires-Dist: numpy>=2.2.2
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas>=2.2.3
Requires-Dist: plotly>=6.0.0
Requires-Dist: polars>=1.21.0
Requires-Dist: pyyaml>=6.0.0
Requires-Dist: rich>=13.9.4
Requires-Dist: ruff>=0.10.0
Requires-Dist: streamlit-extras>=0.6.0
Requires-Dist: streamlit>=1.41.1
Requires-Dist: xlsxwriter>=3.2.2
Description-Content-Type: text/markdown

![Braille fonts](https://see.fontimg.com/api/rf5/DOeDd/MGE4NTM1Njg3NjZhNDZhZTgwNTE0MjE5YzUxMzA0OTgudHRm/VEVYVCBBTkFMWVNJUw/braille-cc0.png?r=dw&h=81&w=1250&fg=00B17E&bg=000000&s=65)

1CijferHO Tool

🚀 Transform DUO data into research insights

    GitHub Last Commit
    Contributors
    GitHub License

  #### 🎬 Demo Video
  Demo

## 📋 Overview
> [!NOTE]
> No Python or technical knowledge required! This tool is designed for everyone, regardless of programming experience.

**Transform DUO's complex educational data into research-ready insights in minutes, not hours.**

### 🚨 The Problem
DUO data comes as:
- Fixed-width ASCII files with no clear field separation
- Unstructured .txt metadata files
- Hours of manual processing required
- High risk of errors and data loss

### ✨ The Solution
Automated pipeline that delivers:
- ⚡ **Fast** - Process GB files in minutes using multiprocessing
- 🎯 **Accurate** - Automated validation prevents errors
- 🔒 **Secure** - Auto-anonymization of sensitive data (BSN, etc.)
- 📊 **Ready** - Clean CSV/Parquet output for immediate analysis

## ✨ Features
- [x] **Smart Extraction** - Auto-finds field positions in messy .txt files
- [x] **Intelligent Matching** - Links data files with metadata automatically
- [x] **Turbo Conversion** - Multiprocessing for blazing speed
- [x] **Quality Validation** - Comprehensive error checking
- [x] **Advanced Data Combination** - YAML-configured joins with decoder files and reference tables
- [x] **Research-Ready Enrichment** - 30+ calculated variables for academic analysis
- [x] **Switch Analysis** - 27+ variables tracking student program switches
- [x] **Smart Case Handling** - Supports snake_case, camelCase, PascalCase, and original formatting
- [x] **File Optimization** - 60-80% size reduction via Parquet compression
- [x] **Privacy Protection** - Cryptographic anonymization
- [x] **Zero Setup** - `uv` handles all dependencies automatically

## 🔧 First Time Setup
> [!WARNING]
> Do not skip these steps if this is your first time using this application. It will not work without them.

> [!TIP]
> Save the repository in a Projects/CEDA folder on your main drive for quick access.

### 1. Get the Repository

#### Option A: Clone with Git (or [Github Desktop](https://github.com/apps/desktop))
```bash
git clone https://github.com/cedanl/1cijferho.git
cd 1cijferho
```

#### Option B: Download ZIP
[![Download Repository](https://img.shields.io/badge/Download-Repository-green)](https://github.com/cedanl/1cijferho/archive/refs/heads/main.zip)

After downloading extract the ZIP file and navigate into the folder.

### 2. Install [![uv Badge](https://img.shields.io/badge/uv-DE5FE9?logo=uv&logoColor=fff&style=flat)](https://docs.astral.sh/uv/)

#### MacOS & Linux (Terminal)
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
```

#### Windows (Powershell or [Windows Terminal](https://apps.microsoft.com/detail/9n0dx20hk701?hl=nl-NL&gl=NL))
```powershell
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
```
Close and reopen your terminal after installation.

#### Verify installation

```bash
uv self update
```

See the [installation documentation](https://docs.astral.sh/uv/getting-started/installation/) for
details and alternative installation methods.

## 🚀 Running the Application

Ready to see the magic happen? Your 1CijferHO Tool is just one command away! ✨

### First, get to the right spot:

Open a terminal in your `1cijferho` folder - it's super easy!
- **Windows**: `Shift + Right-click` in folder → `Open in Windows Terminal`
- **Mac**: `Right-click` folder → `New Terminal at Folder`
- **VS Code**: Just click `Terminal` → `New Terminal`

Or simply navigate there:
```bash
cd path/to/1cijferho
```

### Then, launch with a single command:

```bash
uv run streamlit run src/main.py
```

That's it! The app will automatically spring to life in your browser. If you've completed all the steps in the First Time Setup correctly, this is the **only command** you'll need going forward. 🎉

> **Pro Tip**: Create a shortcut: `.bat` file (Windows) or `.sh` script (macOS/Linux)
> **Pro Tip**: Check out our [architecture.md](architecture.md) for technical details!

Happy analyzing! ✨📊📝

## 🛠️ Built With
[![uv Badge](https://img.shields.io/badge/uv-DE5FE9?logo=uv&logoColor=fff&style=flat)](https://docs.astral.sh/uv/)
[![Streamlit Badge](https://img.shields.io/badge/Streamlit-FF4B4B?logo=streamlit&logoColor=fff&style=flat)](https://streamlit.io/)
[![Python Badge](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=fff&style=flat)](https://www.python.org/)

## 🤲 Support
If you find this project helpful, please consider:
- ⭐ Starring the repo
- 🐛 Reporting bugs
- 💡 Suggesting features
- 💻 Contributing code

If you encounter any issues or need further assistance, please feel free to [open an issue](https://github.com/cedanl/1cijferho/issues) or contact a.sewnandan@hhs.nl | t.iwan@vu.nl

## 🙏 Acknowledgements
Special thanks to:
- [Ash Sewnandan](https://github.com/asewnandan) & [Tomer Iwan](https://github.com/Tomeriko96) for setting the foundation with a clean, user-friendly interface and robust architecture.
- [CEDA & Npuls](https://community-data-ai.npuls.nl/groups/view/44d20066-53a8-48c2-b4e9-be348e05d273/project-center-for-educational-data-analytics-ceda) for making this project possible by providing valuable resources and support.

## 🫂 Contributors
Thank you to all the [people](https://github.com/cedanl/1cijferho/graphs/contributors) who have already contributed to 1cijferho.

[![](https://github.com/asewnandan.png?size=50)](https://github.com/asewnandan)
[![](https://github.com/tin900.png?size=50)](https://github.com/tin900)
[![](https://github.com/Tomeriko96.png?size=50)](https://github.com/Tomeriko96)

## 🚦 License
![GitHub License](https://img.shields.io/github/license/cedanl/1cijferho)
