Metadata-Version: 2.2
Name: brain_rot
Version: 0.1
Summary: Python based Brainrot language'.
Home-page: https://github.com/Shane-Develops/brain_rot
Author: Shane-Develops
Author-email: me@shanewolford.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: requires-python
Dynamic: summary

# BrainRot - Custom Python Syntax Extension

BrainRot is a Python-based language extension that allows you to use `brainrot` instead of `def` for defining functions. It also enables importing and executing `.brainrot` files as if they were regular Python modules.

## Features
- Define functions using `brainrot` instead of `def`.
- Import `.brainrot` files directly into Python.
- Automatically transpiles BrainRot code into valid Python.
- Installable via `pip` from GitHub.

---

## Installation
To install BrainRot from GitHub, run:
```sh
pip install git+https://github.com/Shane-Develops/Brainrot.git
```

---

## Usage

### 1. Create a `.brainrot` File
Create a file called `example.brainrot` and define a function using `brainrot`:
```mog
brainrot sigma():
    rizz("That's a very sigma code!")

sigma()
```

### 2. Import and Execute
Save the file in the same directory as your Python script. Then, in a Python script, import the `.brainrot` file like a normal module:
```python
import brain_rot
import example  # Automatically converts and executes example.brainrot
```
When executed, this will print:
```
Hello from BrainRot!
```

---

## How It Works
- The BrainRot import system finds `.brainrot` files and processes them.
- It replaces `brainrot` with `def`, making the code valid Python.
- The modified code is then compiled and executed seamlessly.

---

## Project Structure
```
brain_rot/
â”‚â”€â”€ brain_rot/
â”‚   â”‚â”€â”€ __init__.py
â”‚   â”‚â”€â”€ brain_rot_importer.py
â”‚â”€â”€ examples/
â”‚   â”‚â”€â”€ example.brainrot
â”‚â”€â”€ setup.py
â”‚â”€â”€ README.md
â”‚â”€â”€ .gitignore
```

---

## Contributing
Feel free to contribute by submitting issues or pull requests on GitHub!

---

## License
This project is licensed under the MIT License.

