SongSeeker Card Generator

Introduction

The SongSeeker Card Generator is a Python script designed to create visual cards based on song data. This tool is part of the SongSeeker project, a music guessing game.

Features

Generate visual cards for songs.
PDF output.
Input data in CSV format.

Prerequisites

Before you start using the SongSeeker Card Generator, make sure you have Python installed on your system. The script is tested with Python 3.11 and above. You can download and install Python from here.

Installation

Clone the repository to your local machine using the following command:

git clone https://github.com/andygruber/songseeker-card-generator.git

Navigate to the cloned directory:

cd songseeker-card-generator

Install the required Python packages:

pip install -r requirements.txt

Usage

To run the script, use the following command:

python card_generator.py <input_csv_path> <output_pdf_path>

Example

python card_generator.py data/example-youtube-songs.csv example.pdf

CSV Input Format

The input CSV file should have the following format:

Title: The title of the song.
Artist: The artist of the song.
Year: The release year of the song.
URL: The YouTube URL of the song.

Make sure your CSV file includes headers and the data is separated by commas.

An example can be found in data/example-youtube-songs.csv.

Contributing

Contributions to the SongSeeker Card Generator are welcome. Please ensure to update tests as appropriate.

License

This project is licensed under the AGPL-3.0 license - see the LICENSE file for details.