45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# CustomBingo
|
|
|
|
A Python application that generates customized BINGO cards from spreadsheet data.
|
|
|
|
## Description
|
|
|
|
CustomBingo reads a spreadsheet with 5 columns (each corresponding to one of the columns on a BINGO card, B, I, N, G, or O), and uses the data in the rows to randomly populate a user-specified number of BINGO cards, exported in PDF format for easy printing. Each box in the grid automatically sizes the font to fit (as large as possible while still being able to read all text), with the text centered horizontally and vertically.
|
|
|
|
## Features
|
|
|
|
- Read Excel/CSV spreadsheets with B, I, N, G, O columns
|
|
- Generate randomized BINGO cards
|
|
- Export cards in PDF format with properly sized text
|
|
- Automatic text centering in grid cells
|
|
- Basic layout with title, column headers, and 5x5 grid
|
|
|
|
## Installation
|
|
|
|
1. Ensure you have Python 3.12+ installed
|
|
2. Install `uv` if not already installed: `pip install uv`
|
|
3. Clone the repository
|
|
4. Navigate to the project directory
|
|
5. Install dependencies: `uv pip install -r requirements.txt` or `uv venv` to create a virtual environment
|
|
|
|
## Usage
|
|
|
|
TODO: Add usage instructions after implementation
|
|
|
|
## Development
|
|
|
|
This project uses `uv` for dependency management. To set up the development environment:
|
|
|
|
```bash
|
|
# Create virtual environment
|
|
uv venv
|
|
|
|
# Activate virtual environment
|
|
# On Windows:
|
|
source .venv/Scripts/activate
|
|
# On macOS/Linux:
|
|
source .venv/bin/activate
|
|
|
|
# Install dependencies
|
|
uv pip install -e .
|
|
``` |