Metadata-Version: 2.4
Name: gregium
Version: 2.2.2
Summary: A package full of prebuilt modules for various common functions
Home-page: https://github.com/LavaTigerUnicrn/Gregium
Author: LavaTigerUnicrn
Author-email: lavatigerunicrn@gmail.com
License: MIT
Project-URL: github, https://github.com/LavaTigerUnicrn/Gregium
Project-URL: issues, https://github.com/LavaTigerUnicrn/Gregium/issues
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: pillow
Requires-Dist: requests
Requires-Dist: dotenv
Requires-Dist: pygame-ce
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: requires-dist
Dynamic: summary

# ![gregiumNameHD](https://github.com/user-attachments/assets/bf3c96d2-e1aa-4117-91cb-93d896145211)

[![PyPi](https://img.shields.io/badge/pypi-2.2.2-%233775A9?style=for-the-badge&logo=pypi&logoColor=white)](https://pypi.org/project/gregium)
[![Github](https://img.shields.io/badge/github-2.2.2-%23181717?style=for-the-badge&logo=github&logoColor=white)](https://github.com/LavaTigerUnicrn/Gregium)
[![License](https://img.shields.io/badge/license-MIT-%233DA639?style=for-the-badge&logo=opensourceinitiative&logoColor=white)](https://opensource.org/license/MIT)
[![Discord](https://img.shields.io/badge/discord-LTU-%235865F2?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/SeKhDF4m5W)
[![Wiki](https://img.shields.io/badge/wiki-informational?style=for-the-badge&logo=gitbook&logoColor=white)](https://github.com/LavaTigerUnicrn/Gregium/wiki)

> Completely remade and ready to not work when you need it most

## What is Gregium

Gregium is a library full of various classes and methods that serve various purposes in many different projects

**Check the [wiki](https://github.com/LavaTigerUnicrn/Gregium/wiki) for more details on the modules of Gregium**

Please note that Gregium is always in development, large changes can come at any time *(although you can read the [changelog](changelog.md) for most changes)*

### Features

AI Helper functions for [Ollama](https://ollama.com/) and [HuggingFace](https://huggingface.co/) Large-Language-Modules (And base code for adding other online APIs such as Claude or GPT)

AI Helper functions for [Vosk](https://alphacephei.com/vosk/) and [Speech Recognition](https://pypi.org/project/SpeechRecognition/) (specifically google) Speech-To-Text

Prebuilt Queue for [Edge-TTS](https://pypi.org/project/edge-tts/) and [RVC-TTS](https://pypi.org/project/tts-with-rvc/) Text-To-Speech

Rendering in terminal

Terminal style commands in Python

HTTP protocol for custom servers

Easy colored (and uncolored) logging formatter

Prebuilt Server-Client system

Additional controls from terminal for both Windows & Linux

And more

## Quick Start

Install Command:

> pip install gregium

To run Gregium testing examples, simply use

> python -m gregium

For an interactive test through all the Gregium functions

## Version Conflicts

Gregium has an automatic version conflict resolver called "library_checker"

In the case where you get any issues with packages on Gregium, use

> python -m gregium --verify

To automatically check for libraries

**This will install *all* libraries even ones that aren't installed by default**

## Help

If you need help on anything, have ideas, or found any bugs with Gregium feel free to join the [Discord](https://discord.gg/SeKhDF4m5W) for assistance or submit an issue to the repository
