monad-std


Namemonad-std JSON
Version 0.10.0 PyPI version JSON
download
home_pagehttps://embers-of-the-fire.github.io/monad-std/
SummaryA library of rust-styled monad utils for python.
upload_time2024-11-16 13:14:08
maintainerNone
docs_urlNone
authorEmbers-of-the-Fire
requires_python<4.0,>=3.8
licenseMIT OR Apache-2.0
keywords monad functional rust pure-python fp
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div style="text-align: center; display: flex; flex-direction: row; justify-content: center; align-items: center;">
<img alt="Logo" height="150" src="logo.svg" width="150"/>
</div>

# Monad STD

<div style="text-align: center;">

[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Embers-of-the-Fire/monad-std/test-python-package.yml?branch=main&logo=github)](https://github.com/Embers-of-the-Fire/monad-std/actions)
![python version](https://img.shields.io/badge/python-%E2%89%A53.8-blue?logo=python)
[![codecov](https://codecov.io/gh/Embers-of-the-Fire/monad-std/graph/badge.svg?token=FIXN2JM4QG)](https://codecov.io/gh/Embers-of-the-Fire/monad-std)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/monad-std?logo=pypi)](https://pypi.org/project/monad-std/)

</div>

`monad_std` is a library that provides some useful Rust-styled utilities for using monads in Python.

<div style="text-align: center;">

[Documentation](https://embers-of-the-fire.github.io/monad-std/) | [PyPI Page](https://pypi.org/project/monad-std/)

</div>

## Quick Start

To install this library, simply use your favorite package manager, here we use pure pip.

```bash
pip install monad-std
```

Then, import the library:

```python-repl
>>> from monad_std import *
>>> Ok(2)
Result::Ok(2)
```

Now you could use the utilities this library provides. For more information and examples, see the documentation above.

For a better guide, see [the documentation's quick start guide](https://embers-of-the-fire.github.io/monad-std/quick%20start/).

## Contribution

Any issue and pull request is welcomed, and you can directly make a pr for new features or open an issue for bug reports.

## Future Plan

Until now, this library provides the following features:

- `monad_std.Option`: An optional value.
- `monad_std.Result`: A structure containing a success value or an error.
    - `monad_std.Ok`: A successful value.
    - `monad_std.Err`: An error value.
- `monad_std.std_types`: Wrapped api around std types.
- `monad_std.iter`: Iterator interface with functors and monads support.
- `monad_std.Either`:
  A structure containing two type of values, but not that specific like `monad_std.Result`.
  (Currently under development.)

            

Raw data

            {
    "_id": null,
    "home_page": "https://embers-of-the-fire.github.io/monad-std/",
    "name": "monad-std",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "monad, functional, rust, pure-python, fp",
    "author": "Embers-of-the-Fire",
    "author_email": "stellarishs@163.com",
    "download_url": "https://files.pythonhosted.org/packages/e3/ef/6273c154eb76889c4812060459f2108aa7c7bce695fbf483956e8b5f9904/monad_std-0.10.0.tar.gz",
    "platform": null,
    "description": "<div style=\"text-align: center; display: flex; flex-direction: row; justify-content: center; align-items: center;\">\n<img alt=\"Logo\" height=\"150\" src=\"logo.svg\" width=\"150\"/>\n</div>\n\n# Monad STD\n\n<div style=\"text-align: center;\">\n\n[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Embers-of-the-Fire/monad-std/test-python-package.yml?branch=main&logo=github)](https://github.com/Embers-of-the-Fire/monad-std/actions)\n![python version](https://img.shields.io/badge/python-%E2%89%A53.8-blue?logo=python)\n[![codecov](https://codecov.io/gh/Embers-of-the-Fire/monad-std/graph/badge.svg?token=FIXN2JM4QG)](https://codecov.io/gh/Embers-of-the-Fire/monad-std)\n[![PyPI - Downloads](https://img.shields.io/pypi/dm/monad-std?logo=pypi)](https://pypi.org/project/monad-std/)\n\n</div>\n\n`monad_std` is a library that provides some useful Rust-styled utilities for using monads in Python.\n\n<div style=\"text-align: center;\">\n\n[Documentation](https://embers-of-the-fire.github.io/monad-std/) | [PyPI Page](https://pypi.org/project/monad-std/)\n\n</div>\n\n## Quick Start\n\nTo install this library, simply use your favorite package manager, here we use pure pip.\n\n```bash\npip install monad-std\n```\n\nThen, import the library:\n\n```python-repl\n>>> from monad_std import *\n>>> Ok(2)\nResult::Ok(2)\n```\n\nNow you could use the utilities this library provides. For more information and examples, see the documentation above.\n\nFor a better guide, see [the documentation's quick start guide](https://embers-of-the-fire.github.io/monad-std/quick%20start/).\n\n## Contribution\n\nAny issue and pull request is welcomed, and you can directly make a pr for new features or open an issue for bug reports.\n\n## Future Plan\n\nUntil now, this library provides the following features:\n\n- `monad_std.Option`: An optional value.\n- `monad_std.Result`: A structure containing a success value or an error.\n    - `monad_std.Ok`: A successful value.\n    - `monad_std.Err`: An error value.\n- `monad_std.std_types`: Wrapped api around std types.\n- `monad_std.iter`: Iterator interface with functors and monads support.\n- `monad_std.Either`:\n  A structure containing two type of values, but not that specific like `monad_std.Result`.\n  (Currently under development.)\n",
    "bugtrack_url": null,
    "license": "MIT OR Apache-2.0",
    "summary": "A library of rust-styled monad utils for python.",
    "version": "0.10.0",
    "project_urls": {
        "Homepage": "https://embers-of-the-fire.github.io/monad-std/",
        "Repository": "https://github.com/Embers-of-the-Fire/monad-std"
    },
    "split_keywords": [
        "monad",
        " functional",
        " rust",
        " pure-python",
        " fp"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "08ca491235bf8c52687457686248fb3b14b5757294ef9b433d1db11924e0c3e1",
                "md5": "68a686db774f20334c98c4c81e09140d",
                "sha256": "4c17299c17d54e61fb6c8c32c89b436e3312aee1a76efd2858f736de0d9c426c"
            },
            "downloads": -1,
            "filename": "monad_std-0.10.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "68a686db774f20334c98c4c81e09140d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 59802,
            "upload_time": "2024-11-16T13:14:06",
            "upload_time_iso_8601": "2024-11-16T13:14:06.631720Z",
            "url": "https://files.pythonhosted.org/packages/08/ca/491235bf8c52687457686248fb3b14b5757294ef9b433d1db11924e0c3e1/monad_std-0.10.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e3ef6273c154eb76889c4812060459f2108aa7c7bce695fbf483956e8b5f9904",
                "md5": "97381aaccc7d01c8beafc69bc9ac8f37",
                "sha256": "8a98934c4204e10677a013c9f902e27c51e565ab5b40530cc48a14ac91b4395d"
            },
            "downloads": -1,
            "filename": "monad_std-0.10.0.tar.gz",
            "has_sig": false,
            "md5_digest": "97381aaccc7d01c8beafc69bc9ac8f37",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 44133,
            "upload_time": "2024-11-16T13:14:08",
            "upload_time_iso_8601": "2024-11-16T13:14:08.785056Z",
            "url": "https://files.pythonhosted.org/packages/e3/ef/6273c154eb76889c4812060459f2108aa7c7bce695fbf483956e8b5f9904/monad_std-0.10.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-16 13:14:08",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Embers-of-the-Fire",
    "github_project": "monad-std",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "monad-std"
}
        
Elapsed time: 0.43360s