Metadata-Version: 2.1
Name: friendly-traceback
Version: 0.2.2
Summary: Friendlier tracebacks in any language.
Home-page: https://github.com/aroberge/friendly-traceback
Author: Andre Roberge
Author-email: Andre.Roberge@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Natural Language :: French
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: Intended Audience :: Education
Classifier: Topic :: Education
Classifier: Topic :: Software Development :: Interpreters
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: executing
Requires-Dist: pure-eval
Requires-Dist: asttokens

# friendly-traceback
Aimed at Python beginners: replacing standard traceback by something easier to understand, translatable into various languages.

![Example](https://raw.githubusercontent.com/aroberge/friendly-traceback/master/why_1.png)

## Installation

```
pip install friendly-traceback
```

In some terminal console, friendly-traceback can make use of [Rich](https://github.com/willmcgugan/rich) if it is installed; this must be done separately
since Rich is not required for this project, although it is **strongly recommended**
if your terminal console supports it.

## Documentation


[Full documentation available here](https://aroberge.github.io/friendly-traceback-docs/docs/html/)

![Example](https://raw.githubusercontent.com/aroberge/friendly-traceback/master/explain.png)


## State of this project

Friendly-traceback is alpha. The current focus is on quickly increasing
the number of exceptions covered.  We strive to test the code as new additions
are made: everything included should work.  However, the code itself
could probably be refactored and could definitely be better documented.

## Contribute

See the documentation. Note that Friendly-traceback uses Black.
![Black logo](https://img.shields.io/badge/code%20style-black-000000.svg)

Some of the ideas were adopted from
[DidYouMean-Python (aka BetterErrorMessages)](https://github.com/SylvainDe/DidYouMean-Python)
by Sylvain Desodt, a project that is also using the MIT license.

## Code of Conduct

We support the
[Python Community Code of Conduct](https://www.python.org/psf/codeofconduct/).
Contributors to this project, including those filing or commenting on an issue,
are expected to do the same.



