semvec/pypi-packages huggingface dataset:
ircstyle 0.1.5
Apply and strip formatting from IRC messages
License: MIT
Requires Python: >=3.7
Keywords: irc

# ircstyle
**ircstyle** is a Python 3.7+ package for applying and stripping formatting from IRC messages. 
Its primary purpose is for use with Python based IRC bots.

[![cicd badge](https://github.com/impredicative/ircstyle/workflows/cicd/badge.svg?branch=master)](https://github.com/impredicative/ircstyle/actions?query=workflow%3Acicd+branch%3Amaster)

## Links
| Caption   | Link                                               |
|-----------|----------------------------------------------------|
| Repo      | https://github.com/impredicative/ircstyle/         |
| Changelog | https://github.com/impredicative/ircstyle/releases |
| Package   | https://pypi.org/project/ircstyle/                 |
| Donation  | [BTC](https://blockchair.com/bitcoin/address/bc1q05p96m0s9kqe9c67jq87sjsnuv6vmzeuxea872) / [LTC](https://blockchair.com/litecoin/address/ltc1q95jq6j78kvyfrvxalwgt9m9xhj9f4r7jfwrqth) / [ETH](https://blockchair.com/ethereum/address/0x0d2d5c576af8ed9f3833f4a3b1e4de6cac2285f0) / [DOGE](https://blockchair.com/dogecoin/address/D5atn8Q9f5iBXrWByxW3i3483QFNH4RFnP) |

## Usage
This package provides two primary methods, **style** and **unstyle**.

### Style
This method is used to style text with IRC attribute and / or color codes.
```python
import ircstyle

ircstyle.style('Hi there', fg='blue', bg='white', bold=True, italics=True, underline=True, reset=True)
'\x0302,00\x02\x1d\x1fHi there\x0f'

ircstyle.style('Hello World!', fg='green', reset=False)
'\x0303Hello World!'

ircstyle.style('ATTENTION!', bold=True, underline=True)
'\x02\x1fATTENTION!\x0f'

ircstyle.style('Something', bg=ircstyle.colors.teal)
'\x0301,10Something\x0f'
```

### Unstyle
This method is used to strip all formatting control codes from IRC messages so that you can safely use the contents outside of IRC in a printable format.
```python
import ircstyle

ircstyle.unstyle('\x02message\x0f')
'message'

ircstyle.unstyle('message')
'message'
```