Metadata-Version: 2.4
Name: Konds-Live-REPL
Version: 1.0.0
Summary: Python library to aid with bug hunting
Author-email: Kondike <ihaditundercontrol@gmail.com>
Maintainer-email: Kondike <ihaditundercontrol@gmail.com>
License-Expression: MIT
License-File: LICENSE.md
Requires-Python: >=3.10
Requires-Dist: colorama>=0.4.6
Requires-Dist: orjson>=3.11.7
Description-Content-Type: text/markdown

# Concept
---

Kond's Live REPL. A remake of Kondikes Debugging Lens (KDL).  A way to cherry pick functions to test and bug hunt for. No need to travel through 5 long functions just to find a typo and a crash, and repeat while testing crash fixes, just boot up KLR, a Command line, and call the function in KLRs syntax.

# How to set up
---

__IMPORTANT NOTICE__: This is a HUGE WIP, so not everything is thought out, and things stated here are expected to change.

__KDL__: See the no longer maintained github page for KDL to get a feel for what this will be.
    - https://github.com/sepforBlueBoi/KDL

# How To Start
---

To start KLR you will need 2 things, a command dict template, and the init function call. 

## Command Template

To be able to actually call the functions you want, you need a command template dict. The file should look something like this:
```py
from my_module import my_func

# The naming does not matter
template = {
    "cmd": "my_func"
}
```

Thats it. You can add as many function commands as you want. 

## The init function

KLR has a init function call. This function handles the start up of KLR. 

```py
from KLR import init

init()
```

init has 2 arguments, the first one is for the command template. the second one is the the command you want to use as it starts up. both are optional, But without the command template KLR cannot reach your functions.

# Other Cool things
---
KLR has 3 call things that make it a step higher then a REPL. Though not by much, as it is all Misc stuff. 

 - clear: KLRs clear function, for clearing the terminal.
 - typrint: KLRs type writer print effect seen at the start of KLR
 - Error Handling: its own custom errors
 - `@__watcher__`: KLR's decorator logger. find logs at /Log
 - Basic commands: echo and help

# Things to come

KLR still has some features that could be ironed out:

 - arguments for function calls are limited to strings
 - toggleale typrint at boot
 - what ever bugs are found
 - -h arguments for printing function docstrings if any found
