Metadata-Version: 2.4
Name: rot-converter
Version: 0.1.0
Summary: A library for the ROT cipher.
Author-email: BasicSweater <ivanvotints@yandex.ru>
License: MIT
Project-URL: Homepage, https://github.com/BasicTShirt/rot-converter/blob/main/README.md
Project-URL: Repository, https://github.com/BasicTShirt/rot-converter
Keywords: rot,converter,beta
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# First Version: 0.1.0!

---

# ROT Converter

A library for the ROT cipher.

## Features

- Encryption and decryption from ROT.
- ROT bruteforce.
- Error handling with clear messages.

## Installation

```bash
pip install rot-converter
```

---

## Usage

- To import, use «from rot_converter import *» or «from rot_converter import m_rot, b_rot».
- To use the library functions, use the command «m_rot(string: str, key: int)» or «b_rot(string: str)».

### For example

#### This program accepts a string (str) as input and outputs this string in the ROT.

```python
from rot import m_rot

temp_str = input() # Input: tqv_eqpxgtvgt
new_str = m_rot(temp_str, 2)

print(new_str) # Output: rot_converter
```
## Requirements

- Python 3.6 or higher.
- No external dependencies (uses only standard library).

---

## Error Handling

The library includes a comprehensive error handling system that validates inputs and provides clear, informative error messages.

### Error Types
| Error                            | Description                                                                          |
|----------------------------------|--------------------------------------------------------------------------------------|
| **You did not enter a string**   | The ROT_string parameter is missing or passed as an empty string ""                  |
| **Key is not an integer**        | The ROT_key parameter cannot be a floating-point number, string, or any non-int type |
| **You did not enter a key**      | The ROT_key parameter is required but missing (None) in manual mode                  |
### Error Examples

```python
from rot import m_rot, b_rot

# Missing string
result = m_rot("", 24)
print(result)
# Output:
# ERROR! You did not enter a string


# Missing key in manual mode
result = m_rot("tqv_eqpxgtvgt", None)
print(result)
# Output:
# ERROR! You did not enter a key


# Key is a float number
result = m_rot("tqv_eqpxgtvgt", 1.5)
print(result)
# Output:
# ERROR! Type of the key is not a integer


# Key is a string
result = m_rot("tqv_eqpxgtvgt", "key")
print(result)
# Output:
# ERROR! Type of the key is not a integer


# Multiple errors (all displayed)
result = m_rot("", 2.5)
print(result)
# Output:
# ERROR! You did not enter a string
# ERROR! Type of the key is not a integer
```
---

## Changelog

| Version   | Date       | Commit                                                                                                    |
|-----------|------------|-----------------------------------------------------------------------------------------------------------|
| **0.1.0** | 07.08.2026 | Beta: First Beta Version On PyPI                                                                          |
###### **Made by the Hi Team.**
