Metadata-Version: 2.4
Name: karoloke
Version: 1.2.0
Summary: A simple karaoke framework to your party!
License: MIT
License-File: LICENSE
Author: Antonio Senra
Author-email: acsenrafilho@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Multimedia :: Video :: Display
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: flask (>=3.1.1,<4.0.0)
Requires-Dist: pydantic (>=2.11.7,<3.0.0)
Requires-Dist: python-dotenv (>=1.1.1,<2.0.0)
Requires-Dist: qrcode[pil] (>=8.2,<9.0)
Requires-Dist: rich (>=14.0.0,<15.0.0)
Description-Content-Type: text/markdown

# Karol-Oke

![Project Logo](docs/assets/karoloke-logo.png)

[![CI for Develop Branch](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_develop.yaml/badge.svg)](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_develop.yaml)
[![CI for Production Branch](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_main.yaml/badge.svg)](https://github.com/acsenrafilho/karoloke/actions/workflows/ci_main.yaml)
[![codecov](https://codecov.io/gh/acsenrafilho/karoloke/graph/badge.svg?token=1PL6N4BI2G)](https://codecov.io/gh/acsenrafilho/karoloke)
![Python Versions](https://img.shields.io/badge/python-3.9%20|+-blue)
![PyPI downloads](https://img.shields.io/pypi/dm/karoloke)
[![Issues](https://img.shields.io/github/issues/acsenrafilho/karoloke)](https://github.com/acsenrafilho/karoloke/issues)
![Contributors](https://img.shields.io/github/contributors/acsenrafilho/karoloke)
[![GitHub Sponsor](https://img.shields.io/badge/Sponsor-❤️%20acsenrafilho-orange?logo=github)](https://github.com/sponsors/acsenrafilho)

A simple Karaoke framework to make your party fun and easy!

## Installation

- Requires **Python 3.9+**
- Install via pip:
  ```bash
  pip install karoloke
  ```

## Usage

- Start the application:
  ```bash
  karoloke
  ```
- The server will start locally.
- Setup your videos database path by simply informing the diretory full path into the settings button (up-right corner) (supports: `.mp4`, `.webm`, `.ogg`).

- The karaoke interface runs in your web browser (Chrome, Firefox, or similar) using an embedded web player for seamless playback.
- Simply open the provided local URL after starting the server to access the karaoke experience.

## Documentation

Full documentation is available at [ReadTheDocs](https://karoloke.readthedocs.io).

## Contributors

Thank you all the special people that invested their time and knowledge to improve this project. 👏

![Contributors](https://contrib.rocks/image?repo=acsenrafilho/karoloke)

