Metadata-Version: 2.4
Name: clarix
Version: 0.0.6
Summary: A professional Python error explanation and debugging assistant with rich UI. (Under development) 
Author: Kane
License: MIT
Keywords: debugging,errors,python,traceback,rich,developer-tools
Classifier: Programming Language :: Python :: 3
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: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Debuggers
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: rich>=13.0.0
Dynamic: license-file

CLARIX
=======

Clarix is a lightweight Python debugging assistant designed to analyze and explain 
runtime errors in a clear and structured manner. It enhances standard Python 
tracebacks with improved readability and contextual insights.


FEATURES
--------
* Structured and readable error explanations
* Highlights the exact line causing failure
* Simple integration with existing Python scripts
* Command-line interface for quick debugging
* Minimal dependencies and lightweight design


INSTALLATION
------------
Install via pip:

    pip install clarix

USAGE
-----

COMMAND LINE
Run Clarix directly in your terminal:

    clarix script.py

PYTHON API
You can also use Clarix inside a code to check the test file :

    import clarix
    clarix.run("test.py")
# You can use clarix.run('<folder>/<file>.py') syntax to run the desired file
    
* You can also directly inject Clarix inside the test file, but generally this is not recommended, as this experimental feature can't handle Syntax-Errors :


    import clarix
    clarix.enable()

CURRENT STATUS
--------------
* Version: Early development stage
* Core functionality implemented
* Actively evolving with new features


ROADMAP
-------
* Advanced error classification
* Improved traceback visualization
* Enhanced contextual explanations
* Support for more error types


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