Metadata-Version: 2.1
Name: RISify
Version: 1.0.0
Summary: Simplifies the encoding and decoding of Regional Indicator Symbols.
Author-email: "M. P. van de Weerd" <michael@parcifal.dev>
License: LICENCE
Project-URL: Homepage, https://gitlab.com/parcifal/ris-py
Project-URL: Bug Tracker, https://gitlab.com/parcifal/ris-py/-/issues
Keywords: unicode,regional indicator symbols,encoding,decoding,flags,internationalization,localization,emoji
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Description-Content-Type: text/markdown
License-File: LICENCE

# RISify

`RISify` is a Python library that provides functions for encoding and decoding 
Regional Indicator Symbols (RIS), which are Unicode characters used to 
represent flags of countries and regions.

## Installation

You can install `RISify` via pip:

```bash
pip install RISify
```

## Usage

```python
from ris import RIS

# decode a country code to RIS
pt = RIS.decode("PT")
print(pt) # 🇵🇹

# decode HTML-symbols to RIS
de = RIS.decode("&#127465;&#127466;", encoding="html")
print(de) # 🇩🇪

# encode a RIS to country code
nl = RIS("🇳🇱")
print(nl.encode()) # NL

# encode a RIS to HTML-safe symbols
fo = RIS("🇫🇴")
print(fo.encode(encoding="html")) # &#127467;&#127476;
```

Note that `RISify` also provides functions for encoding and decoding RIS as 
HTML-safe symbols, which can be useful for ensuring that the symbols are 
markup-safe when used in HTML

## Contributing

Contributions are welcome! If you find a bug or have an idea for a new 
feature, please open an issue on the GitLab repository. If you would like to 
contribute code, please fork the repository and submit a pull request.

## License

`RISify` is released under the GPLv3 license. See [LICENSE](LICENCE) for
details.
