An open API service indexing awesome lists of open source software.

https://github.com/tschm/secretsanta


https://github.com/tschm/secretsanta

christmas santa

Last synced: 3 months ago
JSON representation

Awesome Lists containing this project

README

          

# 🎅 Secret Santa

[![CodeFactor](https://www.codefactor.io/repository/github/tschm/secretsanta/badge)](https://www.codefactor.io/repository/github/tschm/secretsanta)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://github.com/renovatebot/renovate)
[![Maintenance](https://github.com/tschm/secretsanta/actions/workflows/maintain.yml/badge.svg)](https://github.com/tschm/secretsanta/actions/workflows/maintain.yml)
[![Release](https://github.com/tschm/secretsanta/actions/workflows/release.yml/badge.svg)](https://github.com/tschm/secretsanta/actions/workflows/release.yml)
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/tschm/secretsanta)](https://github.com/tschm/secretsanta/releases)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
[![GitHub Pages](https://img.shields.io/badge/GitHub%20Pages-deployed-green)](https://tschm.github.io/secretsanta/marimushka/)

## 🎁 About

A simple yet effective Secret Santa generator application built with Marimo.
This tool helps organize gift exchanges by randomly pairing
participants from two different groups.

## ✨ Features

- 🎯 Create random pairings between two groups
- 🔄 Shuffle names for truly random assignments
- 🖥️ Clean, interactive web interface
- 🚀 Easy to use with simple text input

## 🚀 Getting Started

### 📋 Prerequisites

- Python 3.10+
- Marimo package (installed automatically via `pyproject.toml`)

### 🔧 Installation

```bash
# Clone the repository
git clone https://github.com/tschm/secretsanta.git
cd secretsanta

# Install dependencies
make install
```

### 🎮 Running the Application

```bash
# Start the Marimo app
make app
```

## 🎄 How to Use

1. Enter comma-separated names for the first group
2. Enter comma-separated names for the second group
3. The app will automatically shuffle and display the results
4. Use these pairings for your Secret Santa gift exchange

## 📄 License

This project is licensed under the MIT License - see the LICENSE file for details.