README Template Generator

# tidyframes

![License](https://img.shields.io/badge/license-MIT-blue)
![Python](https://img.shields.io/badge/python-3.10%2B-blue)

Clean messy CSV and Excel exports into tidy, typed data frames with one function call.

## Installation

```bash
pip install tidyframes
```

## Quick start

```python
from tidyframes import tidy

df = tidy("sales_export.xlsx", date_columns=["order_date"])
print(df.dtypes)
```

## Features

- Detects headers, delimiters, and encodings automatically
- Parses dates and currencies into real types
- Reports every change it makes, so nothing is silent

## API

| Function | Description |
| --- | --- |
| `tidy(path, **options)` | Read and clean a file, returning a DataFrame |
| `report(df)` | Summarize the cleaning steps applied |

## Development

```bash
git clone https://github.com/your-name/tidyframes.git
cd tidyframes
pip install -e ".[dev]"
pytest
```

## Contributing

Issues and pull requests are welcome. Please open an issue first for larger changes.

## License

[MIT](LICENSE)

# Customer Churn Prediction

Predicting which subscribers will cancel in the next 30 days, using usage and billing history.

## Results

| Model | ROC-AUC | Precision@10% |
| --- | --- | --- |
| Logistic regression (baseline) | 0.78 | 0.41 |
| Gradient boosting | **0.86** | **0.58** |

![ROC curve](docs/roc-curve.png)

## Data

The dataset is a synthetic sample of 50,000 subscribers, generated by `scripts/make_data.py`.
See [data/README.md](data/README.md) for the column dictionary.

## Reproduce the results

```bash
conda env create -f environment.yml
conda activate churn
python scripts/make_data.py
jupyter nbconvert --execute notebooks/01-model.ipynb
```

## Project structure

```text
├── data/          raw and processed data
├── notebooks/     exploration and modeling
├── scripts/       data generation and training
└── docs/          figures used in this README
```

## Limitations

The model was trained on synthetic data and is meant as a template, not as a production churn model.

# TaskBoard

A small kanban board for personal projects, built with React and Node.

![TaskBoard screenshot](docs/screenshot.png)

**Live demo:** https://taskboard.example.com

## Tech stack

- React 19 and Vite
- Node.js with Express
- PostgreSQL

## Getting started

### Prerequisites

- Node.js 20 or later
- A running PostgreSQL instance

### Run locally

```bash
git clone https://github.com/your-name/taskboard.git
cd taskboard
npm install
cp .env.example .env
npm run dev
```

Open http://localhost:5173.

## Environment variables

| Variable | Description | Example |
| --- | --- | --- |
| `DATABASE_URL` | PostgreSQL connection string | `postgres://user:pass@localhost/taskboard` |
| `SESSION_SECRET` | Random string used to sign cookies | `change-me` |

## Deployment

The app deploys as a single Node service. Set the variables above, run `npm run build`, then `npm start`.

## License

[MIT](LICENSE)

# fastpack

Bundle a folder into a single compressed archive, skipping everything in your `.gitignore`.

## Install

```bash
# macOS and Linux
curl -fsSL https://example.com/fastpack/install.sh | sh

# or with Cargo
cargo install fastpack
```

## Usage

```bash
fastpack ./my-project            # creates my-project.fpk
fastpack ./my-project -o out.fpk # choose the output name
fastpack --list out.fpk          # show the archive contents
```

## Options

| Flag | Description | Default |
| --- | --- | --- |
| `-o, --output` | Output file | `<folder>.fpk` |
| `-l, --level` | Compression level, 1–9 | `6` |
| `--list` | List an archive instead of creating one | off |
| `-q, --quiet` | Suppress progress output | off |

## Exit codes

- `0` success
- `1` invalid arguments
- `2` I/O error

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md).

## License

[Apache-2.0](LICENSE)

# Shelf API

A REST API for managing a personal reading list.

**Base URL:** `https://api.example.com/v1`

## Authentication

Send your API key in the `Authorization` header:

```http
Authorization: Bearer YOUR_API_KEY
```

## Endpoints

| Method | Path | Description |
| --- | --- | --- |
| `GET` | `/books` | List books |
| `POST` | `/books` | Add a book |
| `PATCH` | `/books/{id}` | Update a book |
| `DELETE` | `/books/{id}` | Remove a book |

## Example

```bash
curl https://api.example.com/v1/books \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"title": "Dune", "status": "reading"}'
```

```json
{ "id": "bk_123", "title": "Dune", "status": "reading" }
```

## Errors

| Status | Meaning |
| --- | --- |
| `400` | The request body is invalid |
| `401` | Missing or invalid API key |
| `404` | The book does not exist |
| `429` | Too many requests — retry after the `Retry-After` header |

## Rate limits

100 requests per minute per API key.