Metadata-Version: 2.1
Name: rin
Version: 0.1.2
Summary: A successor to the Lefi project
Home-page: https://github.com/an-dyy/Rin
License: MIT
Keywords: discord,discord-api
Author: an-dyy
Author-email: andy.development@protonmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: aiohttp (>=3.8.1,<4.0.0)
Requires-Dist: python-magic (>=0.4.25,<0.5.0)
Requires-Dist: typing-extensions (>=4.0.1,<5.0.0)
Description-Content-Type: text/markdown

<div align="center">
    <h1>Rin</h1>
    <p>
        <a href="https://rin.readthedocs.io/en/latest/"><img src="https://img.shields.io/readthedocs/rin"</img></a>
        <a href="https://pypi.org/project/rin/"><img src="https://img.shields.io/pypi/dm/rin"</img></a>
        <a href="https://codecov.io/gh/an-dyy/Rin"><img src="https://codecov.io/gh/an-dyy/Rin/branch/master/graph/badge.svg?token=G0UG26MRYO"/></a>
        <a href="https://discord.com/invite/QPFXzFbqrK"><img src="https://img.shields.io/discord/907106240537169980?label=discord"</img></a>
        <a href="https://github.com/an-dyy/Rin/releases"><img src="https://img.shields.io/github/v/release/an-dyy/rin?include_prereleases&sort=semver"</img></a>
    </p>
    A strongly typed discord API wrapper. This is the successor to the Lefi project.
</div>

## Installation

### Installing from GitHub
```
pip install -U git+https://github.com/an-dyy/Rin
```

### Installing from Pypi
Note that since the project is still unstable, the lastest pypi version may be behind master by a lot.
```
pip install -U rin
```

## Example(s)
[Here!](examples/)

## Documentation
[Documentation](https://rin.readthedocs.io/en/latest/index.html)

## Contributing
1. If you plan on contributing please open an issue beforehand
2. Fork the repo, and setup the poetry env (with dev dependencies)
3. Install pre-commit hooks (*makes it a lot easier for me*)
    ```
    pre-commit install
    ```

## Notable contributors

- [blanketsucks](https://github.com/blanketsucks) - collaborator
- [an-dyy](https://github.com/an-dyy) - creator and maintainer

