Metadata-Version: 2.1
Name: roman-empire-reminder
Version: 1.2.1
Summary: A simple Python script to remind the user of the Roman Empire at random intervals, all via toast notifications.
Author: Kendrick Fithen
Author-email: John Reed <ReallyJohnReed@Gmail.com>
Maintainer: Kendrick Fithen
Project-URL: Repository, https://github.com/kfithen/RomanEmpireReminder
Project-URL: Issues, https://github.com/me/kfithen/RomanEmpireReminder/issues
Keywords: Roman,Roman Empire
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Topic :: Games/Entertainment
Classifier: Intended Audience :: End Users/Desktop
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: Microsoft :: Windows :: Windows 10
Classifier: Operating System :: Microsoft :: Windows :: Windows 11
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: datetime
Requires-Dist: pygame
Requires-Dist: pyttsx3
Requires-Dist: windows_toasts; platform_system == "Windows"
Requires-Dist: dbus-python; platform_system == "Linux"

# RomanEmpireReminder

## Description

A simple Python script to remind the user of the Roman Empire at random intervals, all via toast notifications. The intervals range anywhere from every 5 minutes up to an hour.

> [!WARNING]
> I do not own any of the materials that are referenced or shared in this project. These images, sound effects, and other materials belong to their respective copyright holders. Please, do not sue me over some silly Python app!

## Why?

I made this project after remembering an old meme circling the internet in late 2023 where women would approach men and ask them how often they think about the Roman Empire. The meme was that if you were a man and didn't think of the Empire often enough, you would be considered feminine. Dumb, I know, but it spawned this beautiful program to remind you constantly so you don't end up too girly!

## Regarding PascalCase

This was originally written in C#, but I had such a hard time getting Microsoft's own libraries to work with Visual Studio that I decided to rewrite it in Python. Somehow, Python was much easier than using Microsoft's own tools (makes sense, right?), but I liked using C# so much that I wrote the Python script similarly to how I wrote the original script. So there you go, deal with it.

## Installation

Roman Empire Reminder is indexed in PyPi and can be installed with, for example, ```pip install roman-empire-reminder```.

Alternatively, you can run ```pip install path/to/clone``` to install from a local clone.

If for some reason that doesn't work, here is the list of requirements that the script uses:

```requirements.txt
datetime
pygame
pyttsx3

windows_toasts # Windows
dbus-python # Linux
```

The rest of the libraries required should be built into Python, but if not, please check the imports in the `__init__.py`, `__main__.py`, and `notification.py` files in `roman-empire-reminder`.

## How to Run

Run ```py -m roman-empire-reminder``` (Windows) or ```python -m roman-empire-reminder``` (Linux) in Command Prompt / a terminal emulator after installation.

Alternatively, run from the directory by executing `roman-empire-reminder/__main__.py` with python.

## Contributing

Contributions are welcome as long as you don't try to make any drastic changes. As long as you do that, then I would be happy to look at any pull request and see if I approve!
