Metadata-Version: 2.1
Name: slackstyler
Version: 0.0.2
Summary: slackstyler is a Python package that converts strings written in Markdown into Slack message formatting. It provides a simple and convenient conversion of Markdown styles into Slack styles and can be effectively used when creating or integrating with Slack bots.
License: MIT
Author: Youngwook Kim
Author-email: youngwook.kim@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: mistune (<1)
Description-Content-Type: text/markdown

# slackstyler

![Python version](https://img.shields.io/badge/python-3.8-blue)
![License](https://img.shields.io/badge/license-MIT-blue)

`slackstyler` is a Python package that converts Markdown text into Slack message formatting. The motivation for creating this package is to allow Python developers to prepare and send richly-formatted messages to Slack in a way that's familiar and easy to use.

`slackstyler` was inspired by JavaScript's `slackify-markdown` library and also based on `mistune`, a markdown parser in pure Python.

## Features
- Converts Markdown text into Slack message formatting.
- Supports various Markdown syntaxes:
  - **Bold text**
  - *Italic text*
  - [Link](http://atlassian.com)
  - and more...

## Installation
Install `slackstyler` with pip:
```bash
pip install slackstyler
```

## Usage

Here is a quick example of how to use `slackstyler`:

```python
from slackstyler import SlackStyler

# Create a styler instance
styler = SlackStyler()

# Convert markdown text to slack message text
markdown_text = "Hello, **Slack**!"
slack_message = styler.convert(markdown_text)
print(slack_message)
```

When you run this code, you will see:
```
Hello, *Slack*!
```

## Acknowledgments
This project was inspired by [`slackify-markdown`](https://github.com/jsarafajr/slackify-markdown), a similar library written in JavaScript.

## License

`slackstyler` is licensed under the [MIT License](https://opensource.org/licenses/MIT).

