diff options
Diffstat (limited to 'python-friendly-traceback.spec')
| -rw-r--r-- | python-friendly-traceback.spec | 506 |
1 files changed, 506 insertions, 0 deletions
diff --git a/python-friendly-traceback.spec b/python-friendly-traceback.spec new file mode 100644 index 0000000..c145cc7 --- /dev/null +++ b/python-friendly-traceback.spec @@ -0,0 +1,506 @@ +%global _empty_manifest_terminate_build 0 +Name: python-friendly-traceback +Version: 0.7.61 +Release: 1 +Summary: Friendlier tracebacks in any language. +License: MIT License +URL: https://github.com/friendly-traceback/friendly-traceback +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/56/93/f9a360efd1dba0324786d679fdbff630279f3388329b2ae5620514311e99/friendly-traceback-0.7.61.tar.gz +BuildArch: noarch + +Requires: python3-asttokens +Requires: python3-executing +Requires: python3-pure-eval +Requires: python3-stack-data +Requires: python3-six + +%description + +# 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_traceback**. + +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](https://aroberge.github.io/friendly-traceback-docs/docs/html/). + + + +The screenshot above was taken on Windows. In some other operating systems +you might need to type `python3` instead of `python`: **Friendly** +requires Python version 3.6 or newer. + +## Installation + +``` +python -m pip install friendly_traceback +``` + +Note that 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](https://codewith.mu) that has its own way +of installing Python packages, please consult the documentation. + +## Documentation + +[The documentation is available by clicking here.](https://friendly-traceback.github.io/docs/index.html) + +## Example + +The following example illustrates the information that can +be provided by **Friendly**. + +``` + Traceback (most recent call last): + File "<friendly-console:5>", line 1, in <module> + test() + File "<friendly-console:4>", line 2, in test + a = cost(pi) + NameError: name 'cost' is not defined + + 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 +``` + +## Projects using Friendly + +friendly/friendly-traceback is used by: + +* [HackInScience](https://hackinscience.org) +* [futurecoder](https://futurecoder.io) +* [CodeGrade](https://www.codegrade.com/blog/friendly-better-error-messages-for-python) +* [ddebug](https://github.com/matan-h/ddebug) + +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](CONTRIBUTING.md) + +## License: MIT + +For more details, see [LICENSE](LICENSE). + +Some 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; 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](CODE_OF_CONDUCT.md) + +## JetBrains support + +We graciously acknowledge the support of [JetBrains]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) +which enables us to use the professional version +of PyCharm for developing **Friendly**. + +[]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) + + +%package -n python3-friendly-traceback +Summary: Friendlier tracebacks in any language. +Provides: python-friendly-traceback +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-friendly-traceback + +# 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_traceback**. + +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](https://aroberge.github.io/friendly-traceback-docs/docs/html/). + + + +The screenshot above was taken on Windows. In some other operating systems +you might need to type `python3` instead of `python`: **Friendly** +requires Python version 3.6 or newer. + +## Installation + +``` +python -m pip install friendly_traceback +``` + +Note that 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](https://codewith.mu) that has its own way +of installing Python packages, please consult the documentation. + +## Documentation + +[The documentation is available by clicking here.](https://friendly-traceback.github.io/docs/index.html) + +## Example + +The following example illustrates the information that can +be provided by **Friendly**. + +``` + Traceback (most recent call last): + File "<friendly-console:5>", line 1, in <module> + test() + File "<friendly-console:4>", line 2, in test + a = cost(pi) + NameError: name 'cost' is not defined + + 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 +``` + +## Projects using Friendly + +friendly/friendly-traceback is used by: + +* [HackInScience](https://hackinscience.org) +* [futurecoder](https://futurecoder.io) +* [CodeGrade](https://www.codegrade.com/blog/friendly-better-error-messages-for-python) +* [ddebug](https://github.com/matan-h/ddebug) + +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](CONTRIBUTING.md) + +## License: MIT + +For more details, see [LICENSE](LICENSE). + +Some 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; 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](CODE_OF_CONDUCT.md) + +## JetBrains support + +We graciously acknowledge the support of [JetBrains]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) +which enables us to use the professional version +of PyCharm for developing **Friendly**. + +[]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) + + +%package help +Summary: Development documents and examples for friendly-traceback +Provides: python3-friendly-traceback-doc +%description help + +# 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_traceback**. + +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](https://aroberge.github.io/friendly-traceback-docs/docs/html/). + + + +The screenshot above was taken on Windows. In some other operating systems +you might need to type `python3` instead of `python`: **Friendly** +requires Python version 3.6 or newer. + +## Installation + +``` +python -m pip install friendly_traceback +``` + +Note that 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](https://codewith.mu) that has its own way +of installing Python packages, please consult the documentation. + +## Documentation + +[The documentation is available by clicking here.](https://friendly-traceback.github.io/docs/index.html) + +## Example + +The following example illustrates the information that can +be provided by **Friendly**. + +``` + Traceback (most recent call last): + File "<friendly-console:5>", line 1, in <module> + test() + File "<friendly-console:4>", line 2, in test + a = cost(pi) + NameError: name 'cost' is not defined + + 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 +``` + +## Projects using Friendly + +friendly/friendly-traceback is used by: + +* [HackInScience](https://hackinscience.org) +* [futurecoder](https://futurecoder.io) +* [CodeGrade](https://www.codegrade.com/blog/friendly-better-error-messages-for-python) +* [ddebug](https://github.com/matan-h/ddebug) + +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](CONTRIBUTING.md) + +## License: MIT + +For more details, see [LICENSE](LICENSE). + +Some 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; 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](CODE_OF_CONDUCT.md) + +## JetBrains support + +We graciously acknowledge the support of [JetBrains]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) +which enables us to use the professional version +of PyCharm for developing **Friendly**. + +[]( +https://www.jetbrains.com/community/opensource/?from=friendly-traceback) + + +%prep +%autosetup -n friendly-traceback-0.7.61 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-friendly-traceback -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 0.7.61-1 +- Package Spec generated |