https://github.com/nekitdev/wraps
Meaningful and safe wrapping types.
https://github.com/nekitdev/wraps
future option python result wraps
Last synced: about 2 months ago
JSON representation
Meaningful and safe wrapping types.
- Host: GitHub
- URL: https://github.com/nekitdev/wraps
- Owner: nekitdev
- License: mit
- Created: 2022-06-28T15:20:55.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T14:19:41.000Z (over 1 year ago)
- Last Synced: 2024-11-17T13:51:50.409Z (over 1 year ago)
- Topics: future, option, python, result, wraps
- Language: Python
- Homepage: https://nekitdev.github.io/wraps
- Size: 956 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# `wraps`
[![License][License Badge]][License]
[![Version][Version Badge]][Package]
[![Downloads][Downloads Badge]][Package]
[![Discord][Discord Badge]][Discord]
[![Documentation][Documentation Badge]][Documentation]
[![Check][Check Badge]][Actions]
[![Test][Test Badge]][Actions]
[![Coverage][Coverage Badge]][Coverage]
> *Meaningful and safe wrapping types.*
## Installing
**Python 3.8 or above is required.**
### `pip`
Installing the library with `pip` is quite simple:
```console
$ pip install wraps
```
Alternatively, the library can be installed from the source:
```console
$ pip install git+https://github.com/nekitdev/wraps.git
```
Or via cloning the repository:
```console
$ git clone https://github.com/nekitdev/wraps.git
$ cd wraps
$ pip install .
```
### `uv`
You can add `wraps` as a dependency with the following command:
```console
$ uv add wraps
```
## Examples
TODO
## Documentation
You can find the documentation [here][Documentation].
## Support
If you need support with the library, you can send us an [email][Email]
or refer to the official [Discord server][Discord].
## Changelog
You can find the changelog [here][Changelog].
## Security Policy
You can find the Security Policy of `wraps` [here][Security].
## Contributing
If you are interested in contributing to `wraps`, make sure to take a look at the
[Contributing Guide][Contributing Guide], as well as the [Code of Conduct][Code of Conduct].
## License
`wraps` is licensed under the MIT License terms. See [License][License] for details.
[Email]: mailto:support@nekit.dev
[Discord]: https://nekit.dev/chat
[Actions]: https://github.com/nekitdev/wraps/actions
[Changelog]: https://github.com/nekitdev/wraps/blob/main/CHANGELOG.md
[Code of Conduct]: https://github.com/nekitdev/wraps/blob/main/CODE_OF_CONDUCT.md
[Contributing Guide]: https://github.com/nekitdev/wraps/blob/main/CONTRIBUTING.md
[Security]: https://github.com/nekitdev/wraps/blob/main/SECURITY.md
[License]: https://github.com/nekitdev/wraps/blob/main/LICENSE
[Package]: https://pypi.org/project/wraps
[Coverage]: https://codecov.io/gh/nekitdev/wraps
[Documentation]: https://nekitdev.github.io/wraps
[Discord Badge]: https://img.shields.io/discord/728012506899021874
[License Badge]: https://img.shields.io/pypi/l/wraps
[Version Badge]: https://img.shields.io/pypi/v/wraps
[Downloads Badge]: https://img.shields.io/pypi/dm/wraps
[Documentation Badge]: https://github.com/nekitdev/wraps/workflows/docs/badge.svg
[Check Badge]: https://github.com/nekitdev/wraps/workflows/check/badge.svg
[Test Badge]: https://github.com/nekitdev/wraps/workflows/test/badge.svg
[Coverage Badge]: https://codecov.io/gh/nekitdev/wraps/branch/main/graph/badge.svg