Metadata-Version: 2.4
Name: parse4u
Version: 1.1.3
Summary: converts python language into plain english
Author-email: Fawaz Shariff <placeholder0254@gmail.com>
License: MIT
Project-URL: Homepage, https://github.com/Chungywungy/BCIT-Hacakathon
Project-URL: Documentation, https://github.com/Chungywungy/BCIT-Hacakathon
Project-URL: Source, https://github.com/Chungywungy/BCIT-Hacakathon/tree/main/src/parse4u
Keywords: automation,parsing,Summarizing
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# BCIT-Hackathon

# About
This program allows users to input non-built-in Python functions and receive a plain-English explanation of
what the function does. The system analyzes the structure and logic of the code, then translates it into a concise
summary that is easy for beginner developers to understand. The goal is to make learning programming easier by
helping users quickly grasp how code works without needing more advanced knowledge.


# Instructions
1. Open terminal
2. Type in "pip install parse4u"
```terminaloutput
pip install parse4u
```
3. Open python file
4. Import parse4u
5. Type in "generate()"
```python
from parse4u import *

generate()
```
6. Enter (or copy and paste) your code for your Python function
7. Press Ctrl + D or type "END" to start parsing your code

```terminaloutput
Enter/Paste your content. Type " END " or press Ctrl-D or Ctrl-Z on windows to save it.

def something():
    return nothing
END

OUTPUT:
something is declared as a function. It takes no parameters.
return nothing
```

# Authors
James 
Flora
Saba
Ollie
Fawaz

# License
This project is licensed under the MIT License - see the [LICENSE](./LICENSE) file for details.
