Skip to main content

A fully type-annotated Rust-like Result type for Python.

Project description

result

A fully type-annotated Rust-like Result type for Python.

Badges 📛

project status badges:

CI Workflow Coverage Documentation Status Package Health

version badges:

Project Version Python Versions Cookiecutter: cc-python Docker: bbugyi/python

tools / frameworks used by test suite (i.e. used by make test):

Framework: pytest Framework: doctest Runner: tox Types: typeguard Mocks: pytest-mock Snapshots: syrupy

linters used to maintain code quality (i.e. used by make lint):

Linter: pylint Linter: flake8 Types: mypy Docstrings: pydocstyle Code Style: black Imports: isort

tools / frameworks used to render documentation (i.e used by make build-docs):

Rendered By: sphinx Hosted On: ReadTheDocs Types: sphinx-autodoc-typehints Markdown: m2r2

miscellaneous tools used to maintain this project:

Cookiecutter Updates: cruft Requirements: pip-tools Releases: bump2version Versioning: setuptools_scm

Installation 🗹

To install python-result using pip, run the following commands in your terminal:

python3 -m pip install --user python-result  # install result

If you don't have pip installed, this Python installation guide can guide you through the process.

Useful Links 🔗

  • API Reference: A developer's reference of the API exposed by this project.
  • cc-python: The cookiecutter that was used to generate this project. Changes made to this cookiecutter are periodically synced with this project using cruft.
  • CHANGELOG.md: We use this file to document all notable changes made to this project.
  • CONTRIBUTING.md: This document contains guidelines for developers interested in contributing to this project.
  • Create a New Issue: Create a new GitHub issue for this project.
  • Documentation: This project's full documentation.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-result-0.2.1.tar.gz (29.4 kB view details)

Uploaded Source

Built Distribution

python_result-0.2.1-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file python-result-0.2.1.tar.gz.

File metadata

  • Download URL: python-result-0.2.1.tar.gz
  • Upload date:
  • Size: 29.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for python-result-0.2.1.tar.gz
Algorithm Hash digest
SHA256 2d4f0570cc20c326e041ce35a75326ba9085b7b8a6fe4d8fcace349cd5d86f13
MD5 ee8aed1ddd242de0fa7ea95f33351521
BLAKE2b-256 258825187fa6af126b0f59478c387fe1ffc6536130e3500aeb24bfa7ba7fd85d

See more details on using hashes here.

File details

Details for the file python_result-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: python_result-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 6.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for python_result-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f7a63f919cbf8515f24a0f3145009be107fe60496c09a5d6cbf8e46f429551cb
MD5 b7051b40142e729bf636f8c858fd42aa
BLAKE2b-256 5d95c41d846b37d3ca3a5b13e28d91cbd90d5f6a4f6c94c3602aa72c295e7a54

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page