https://github.com/timelessnesses/dpyhr

dpyhr is a hot cog reloader (that uses discord.py cog's implementation) to reload anytime you wanted to save!
https://github.com/timelessnesses/dpyhr

Last synced: 13 days ago
JSON representation

dpyhr is a hot cog reloader (that uses discord.py cog's implementation) to reload anytime you wanted to save!

• Host: GitHub
• URL: https://github.com/timelessnesses/dpyhr
• Owner: timelessnesses
• License: mit
• Created: 2023-01-17T13:41:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-14T06:09:42.000Z (almost 2 years ago)
• Last Synced: 2024-12-08T22:58:45.417Z (about 1 month ago)
• Language: Python
• Size: 67.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-discordpy - timelessnesses/dpyhr - Dpyhr is a hot cog reloader (that uses discord.py cog's implementation) to reload anytime you wanted to save. (Libraries and Extensions / Utilities)

README

        
# dpyhr

dpyhr is a hot cog reloader (that uses discord.py cog's implementation) to reload anytime you wanted to save!

## Setup

1. Install dpyhr with pip (`pip install dpyhr`)

2. Import dpyhr and run it with

```py

import dpyhr

dpyhr.run(

    *paths: str,

    bot: commands.Bot = None,

    selection: Selection = Selection.normal,

    reloader: typing.Callable = None,

    conditional: typing.Callable = None,

    recursive: bool = False,

    **kwargs

)

```

`dpyhr.run` have a documentation as this

> Run dphyr in another thread.  

>    Args:  

>        *paths (str): Paths you want to watch for cogs. Supply those as argument  

>        bot (commands.Bot, Optional): For reloading extensions (if reloader doesn't exists)  

>        selection (Selection, optional): Observer selection. Defaults to Selection.normal.  

>        reloader (typing.Callable, optional): Reload module with your own function. Defaults to None.  

>        conditional (typing.Callable, optional): Conditional when event is triggered. Defaults to None.  

>        recursive (bool, optional): Recursive reloading. Defaults to False.  

>        **kwargs: Other arguments for observer.  

>    Returns:  

>        None: No returns.  

## Caution

dpyhr wouldn't work if you called your bot outside of the entrypoint starter so nested path wouldn't work in this case. you need to run it inside directory where you want python file to run else reloader might get wrong path and spits errors out.

## Why you don't shipped discord.py with this package?

Because dpyhr is trying to be able to compatible with any discord.py versions that have `discord.ext.commands` (other discord.py forks should works if they have `commands.Bot.reload_extension` and their package name is `discord`)