Metadata-Version: 2.1
Name: friendly
Version: 0.3.36
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 (>=0.5.3)
Requires-Dist: pure-eval (>=0.2.1)
Requires-Dist: asttokens (>=2.0.4)
Requires-Dist: rich (>=9.12)
Requires-Dist: pygments (>=2.6)

# friendly

Aimed at Python beginners: replacing standard traceback by something easier to understand,
translatable into various languages. **friendly** can provide additional
information such as `why()` a certain exception occurred,
`what()` it is, exactly `where()` it occurred including
the value of relevant variables, and
[more](https://aroberge.github.io/friendly-traceback-docs/docs/html/).


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

**friendly** used to be called **friendly-traceback**.


## Installation

```
pip install friendly
```

## Documentation

[The documentation is available by clicking here.](https://aroberge.github.io/friendly-traceback-docs/docs/html/)

## Example

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


## Contribute

Contribute by making suggestions for improvements, pointing out mistakes either in
the documentation or in the information provided by Friendly, or finding bugs.

If you speak a language other than English or French and feel ambitious, you might
want to work on translations into your own language.

## License: MIT

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 agree with the goals behind the creation of 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.


## JetBrains support

We graciously acknowledge the support of [JetBrains](
https://www.jetbrains.com/?from=friendly-traceback)
which enables us to use the professional version
of PyCharm for developing Friendly.


