rupi 0.1.24

A Python library for my codes.

Rupi - The FLAMES Game in Python

Pali is a simple Python library to play the classic FLAMES game, where you calculate the relationship between two names based on the number of remaining letters after eliminating common ones. The result provides a relationship status like Friends, Love, Marriage, Enemies, etc.

Features

• FLAMES Calculation: Determines the relationship between two names.
• Interactive CLI: Optionally play the game directly via command line.
• Simple API: Easy to integrate into your Python projects.

Installation

You can install the rupi library via pip.

Via pip (from PyPI)

pip install rupi

From source

To install rupi directly from the GitHub repository:

git clone https://github.com/TanujairamV/rupi.git
cd rupi
python setup.py install

Usage

After installing, you can use the flames function to determine the relationship between two names.

Example 1: Using the library in Python

from rupi import flames

# Example names
result = flames("Alice", "Bob")
print(result)  # Output: 'Enemies'

Example 2: Interactive CLI

You can also run the rupi package directly from the command line for an interactive FLAMES game.

python -m rupi.flames

This will prompt you to enter two names and will print the relationship result.

Example Output:

Welcome to the FLAMES Game!
Enter the first name: Alice
Enter the second name: Bob
The relationship between Alice and Bob is: Enemies

Contributing

We welcome contributions to the rupi library! Here’s how you can help:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to your branch (git push origin feature-branch).
5. Open a pull request on GitHub.

Guidelines

• Write clear commit messages.
• Ensure all new features or fixes have tests.
• Follow PEP 8 style guidelines.

Running Tests

To run the tests for rupi, make sure you have pytest installed:

pip install pytest

Then, run the tests:

pytest tests/

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

• Author: Tanujairam
• Email: [e-mail]
• GitHub: https://github.com/TanujairamV/pali