nonnaghcaz/kharon

The ferryman you need to travel the gap from Red v2 to Red v3.

Kharon

The ferryman you need to travel the gap from Red v2 to Red v3.

Join my Discord server: https://discord.gg/zw7NmT

---

DESCRIPTION

Kharon is a python module that will assist you in transitioning your Red-discordBot cogs from v2 to v3.

Notably, Kharon will:

• Format info.json files

Kharon also provides both synchronous and asynchronous versions of any method performing HTTP requests.

---

INSTALL

Now on PyPI!

python -m pip install Kharon

---

REQUIREMENTS

You need at least one of the following:

• requests for synchronous requests
• aiohttp for asynchronous requests

When installing with pip, both requests and aiohttp will be downloaded as well as Kharon.

---

USAGE

Kharon can be imported to be used in custom scripts and modules, ran from the command line as a service, or tested at the live site.

Option 1: Module Import

from kharon import kharon  

data = kharon.format_info(  
    user='github_user', repo='repo_name', cogs='cog_name')  
print(data)  

If no cogs are listed, then Kharon will run for all cogs in the repository.

Option 2: CLI Command

$ Kharon -u <github_user> -r <repo_name> -c <cog_name> (optional)

Option 3: Live Demo

Visit my personal webpage, built with Django and hosted by the wonderful people at PythonAnywhere, or go directly to the Demo.

---

CONTRIBUTION

Follow these 5 easy steps for a successful contribution (by @Redjumpman):

1. Fork it!
2. Develop your feature branch
3. Commit your changes
4. Push to the main branch
5. Submit a pull request

---

LICENSE

The project is licensed under MIT. Feel free to alter this project anyway you see fit, as long as I am credited for the original work.

kharon's Issues

Road Map

Available Features:

• Format info.json files in the new v3 format

Upcoming Features:

• Format v3 formatted info.json files to v2 format. I don't know why you'd want this...
• Export new info.json file (backup old with .bak suffix)