friendly
Friendly-traceback's version used in most situations
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
✓Academic publication links
Links to: science.org -
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.4%) to scientific vocabulary
Repository
Friendly-traceback's version used in most situations
Basic Info
- Host: GitHub
- Owner: friendly-traceback
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://friendly-traceback.github.io/docs/index.html
- Size: 350 KB
Statistics
- Stars: 41
- Watchers: 1
- Forks: 5
- Open Issues: 4
- Releases: 0
Metadata Files
README.md
friendly/friendly-traceback
- friendly_traceback: Helps understand Python traceback
- friendly: Prettier version of the above with some additional enhancements.
This code repository is for friendly.
Unless specified otherwise, from here on, Friendly will refer to both friendly and friendly_traceback
Description
Created with Python beginners in mind, but also useful for experienced users, Friendly replaces standard tracebacks by something easier to understand, translatable into various languages. Currently, the information provided by Friendly is only available in two languages: English and French.
The additional information provided by Friendly includes
why() a certain exception occurred,
what() it means, exactly where() it occurred including
the value of relevant variables, and
more.
Installation
Most users should install friendly instead of friendly_traceback,
python -m pip install friendly
This needs to be done from a terminal.
In the command shown above,
python refers to whatever you need to type to invoke your
favourite Python interpreter.
It could be python, python3, py -3.8, etc.
For some special cases, including using a specialized editor like Mu that has its own way of installing Python packages, please consult the documentation.
Documentation
The documentation is available by clicking here.
Example
The following example illustrates the information that can be provided by Friendly.
First, we show the output of friendly-traceback
```
Traceback (most recent call last):
File "friendly-console:5", line 1, in
Did you mean `cos`?
A `NameError` exception indicates that a variable or
function name is not known to Python.
Most often, this is because there is a spelling mistake.
However, sometimes it is because the name is used
before being defined or given a value.
In your program, `cost` is an unknown name.
Instead of writing `cost`, perhaps you meant one of the following:
* Global scope: `cos`, `cosh`, `acos`
Execution stopped on line 1 of file `'<friendly-console:5>'`.
-->1: test()
test: <function test>
Exception raised on line 2 of file `'<friendly-console:4>'`.
1: def test():
-->2: a = cost(pi)
^^^^
global pi: 3.141592653589793
```
Next, the same output shown as a screen capture when using friendly.
Projects using Friendly
friendly/friendly-traceback is used by:
Feel free to contact me to add your project to this list.
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.
For more details, see CONTRIBUTING
License: MIT
For more details, see LICENSE.
Some ideas were adopted from DidYouMean-Python (aka BetterErrorMessages) by Sylvain Desodt, a project that is also using the MIT license; as of October 2021, that particular project is no longer maintained.
Code of Conduct
In short: be respectful of everyone.
For more details, see Code of Conduct
JetBrains support
We graciously acknowledge the support of JetBrains which enables us to use the professional version of PyCharm for developing Friendly.
Owner
- Name: friendly-traceback
- Login: friendly-traceback
- Kind: organization
- Repositories: 7
- Profile: https://github.com/friendly-traceback
GitHub Events
Total
- Issues event: 2
- Watch event: 1
- Issue comment event: 1
Last Year
- Issues event: 2
- Watch event: 1
- Issue comment event: 1
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| André Roberge | a****e@g****m | 179 |
| Luca Chiodini | l****a@c****g | 1 |
| oleg.hoefling | o****g@g****m | 1 |
| Julien Palard | j****n@p****r | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: about 1 year ago
All Time
- Total issues: 49
- Total pull requests: 5
- Average time to close issues: about 1 month
- Average time to close pull requests: 9 minutes
- Total issue authors: 9
- Total pull request authors: 4
- Average comments per issue: 2.57
- Average comments per pull request: 1.4
- Merged pull requests: 5
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 0
- Average time to close issues: about 1 month
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 1.0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- aroberge (33)
- mardukbp (7)
- JulienPalard (3)
- psychemedia (2)
- ShalokShalom (1)
- zerocewl (1)
- MustCodeAl (1)
- thewchan (1)
- kevinbowen777 (1)
Pull Request Authors
- aroberge (2)
- lucach (1)
- JulienPalard (1)
- hoefling (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 2
-
Total downloads:
- pypi 7,767 last-month
-
Total dependent packages: 5
(may contain duplicates) -
Total dependent repositories: 20
(may contain duplicates) - Total versions: 186
- Total maintainers: 1
pypi.org: friendly
Friendlier tracebacks in any language.
- Homepage: https://github.com/friendly-traceback/friendly
- Documentation: https://friendly.readthedocs.io/
- License: MIT License
-
Latest release: 0.7.21
published over 3 years ago
Rankings
Maintainers (1)
conda-forge.org: friendly
- Homepage: https://github.com/friendly-traceback/friendly
- License: MIT
-
Latest release: 0.7.20
published over 3 years ago
Rankings
Dependencies
- colorama *
- friendly-traceback >=0.5.46
- friendly_styles >=0.1
- platformdirs *
- pygments *
- rich >=11
- pytest * development