https://github.com/bbugyi200/result
A fully type-annotated Rust-like Result type for Python.
https://github.com/bbugyi200/result
cc-python python
Last synced: about 1 year ago
JSON representation
A fully type-annotated Rust-like Result type for Python.
- Host: GitHub
- URL: https://github.com/bbugyi200/result
- Owner: bbugyi200
- Created: 2021-09-26T21:09:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-11-28T16:29:15.000Z (over 4 years ago)
- Last Synced: 2024-07-03T17:27:48.637Z (almost 2 years ago)
- Topics: cc-python, python
- Language: Python
- Homepage:
- Size: 57.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# result
**A fully type-annotated Rust-like Result type for Python.**
## Badges 📛
project status badges:
[](https://github.com/bbugyi200/result/actions/workflows/ci.yml)
[](https://codecov.io/gh/bbugyi200/result)
[](https://result.readthedocs.io/en/latest/?badge=latest)
[](https://snyk.io/advisor/python/python-result)
version badges:
[](https://pypi.org/project/python-result/)
[](https://pypi.org/project/python-result/)
[](https://github.com/bbugyi200/cc-python)
[](https://github.com/bbugyi200/docker-python)
tools / frameworks used by test suite (i.e. used by `make test`):
[](https://github.com/pytest-dev/pytest)
[](https://docs.python.org/3/library/doctest.html)
[](https://github.com/tox-dev/tox)
[](https://github.com/agronholm/typeguard)
[](https://github.com/pytest-dev/pytest-mock)
[](https://github.com/tophat/syrupy)
linters used to maintain code quality (i.e. used by `make lint`):
[](https://github.com/PyCQA/pylint)
[](https://github.com/PyCQA/flake8)
[](https://github.com/python/mypy)
[](https://github.com/PyCQA/pydocstyle)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/isort)
tools / frameworks used to render documentation (i.e used by `make build-docs`):
[](https://github.com/sphinx-doc/sphinx)
[](https://docs.readthedocs.io/en/stable/)
[](https://github.com/agronholm/sphinx-autodoc-typehints)
[](https://github.com/CrossNox/m2r2)
miscellaneous tools used to maintain this project:
[](https://github.com/cruft/cruft)
[](https://github.com/jazzband/pip-tools)
[](https://github.com/c4urself/bump2version)
[](https://github.com/pypa/setuptools_scm)
## Installation 🗹
To install `python-result` using [pip][9], run the following
commands in your terminal:
``` shell
python3 -m pip install --user python-result # install result
```
If you don't have pip installed, this [Python installation guide][10] can guide
you through the process.
## Useful Links 🔗
* [API Reference][3]: A developer's reference of the API exposed by this
project.
* [cc-python][4]: The [cookiecutter][5] that was used to generate this project.
Changes made to this cookiecutter are periodically synced with this project
using [cruft][12].
* [CHANGELOG.md][2]: We use this file to document all notable changes made to
this project.
* [CONTRIBUTING.md][7]: This document contains guidelines for developers
interested in contributing to this project.
* [Create a New Issue][13]: Create a new GitHub issue for this project.
* [Documentation][1]: This project's full documentation.
[1]: https://result.readthedocs.io/en/latest
[2]: https://github.com/bbugyi200/result/blob/master/CHANGELOG.md
[3]: https://result.readthedocs.io/en/latest/modules.html
[4]: https://github.com/bbugyi200/cc-python
[5]: https://github.com/cookiecutter/cookiecutter
[6]: https://docs.readthedocs.io/en/stable/
[7]: https://github.com/bbugyi200/result/blob/master/CONTRIBUTING.md
[8]: https://github.com/bbugyi200/result
[9]: https://pip.pypa.io
[10]: http://docs.python-guide.org/en/latest/starting/installation/
[11]: https://github.com/pypa/pipx
[12]: https://github.com/cruft/cruft
[13]: https://github.com/bbugyi200/result/issues/new/choose