scurrypy 0.3.2__py3-none-any.whl → 0.3.4.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of scurrypy might be problematic. Click here for more details.

@@ -1,85 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: scurrypy
3
- Version: 0.3.2
4
- Summary: Discord API Wrapper in Python
5
- Author: Furmissile
6
- Requires-Python: >=3.10
7
- Description-Content-Type: text/markdown
8
- License-File: LICENSE
9
- Dynamic: license-file
10
-
11
- # __Welcome to ScurryPy__
12
-
13
- [![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
14
-
15
- Yet another Discord API wrapper in Python!
16
-
17
- While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.
18
-
19
- ## Features
20
- * Command and event handling
21
- * Declarative style using decorators
22
- * Supports both legacy and new features
23
- * Respects Discord's rate limits
24
-
25
- ## Something things to consider...
26
- * This is an early version — feedback, ideas, and contributions are welcome! With that said, there will be bumps in the road so expect bugs and other flaws!
27
- * Some features are not yet supported, such as sharding and automod, while others, like voice, will never be supported. While this library can handle many of your basic needs, common features such as sharding or auto-mod actions are not yet implemented. See the [license](LICENSE) for details on usage.
28
-
29
-
30
- ## Getting Started
31
- While this tab shows up in the docs, here are some complete examples where all you need to do is pop in your bot's credentials!
32
-
33
- ## Installation
34
- To install the ScurryPy package, run:
35
- ```bash
36
- pip install scurrypy
37
- ```
38
-
39
- ## Minimal Slash Command
40
- The following demonstrates building and responding to a slash command.
41
- ```python
42
- import discord, os
43
- from dotenv import load_dotenv
44
-
45
- load_dotenv(dotenv_path='./path/to/env') # omit argument if your env file is on the same level
46
-
47
- bot = discord.Client(
48
- token=os.getenv("DISCORD_TOKEN"),
49
- application_id=APPLICATION_ID # replace with your bot's user ID
50
- )
51
-
52
- @bot.command(
53
- command=discord.SlashCommand(name='example', description='Demonstrate the minimal slash command!'),
54
- guild_id=GUILD_ID # must be a guild ID your bot is in!
55
- )
56
- async def example(bot: discord.Client, event: discord.InteractionEvent):
57
- await event.interaction.respond(f'Hello, {event.interaction.member.user.username}!')
58
-
59
- bot.run()
60
- ```
61
-
62
- ## Minimal Prefix Command (Legacy)
63
- The following demonstrates building and responding to a message prefix command.
64
- ```python
65
- import discord, os
66
- from dotenv import load_dotenv
67
-
68
- load_dotenv(dotenv_path='./path/to/env') # omit argument if your env file is on the same level
69
-
70
- bot = discord.Client(
71
- token=os.getenv("DISCORD_TOKEN"),
72
- application_id=APPLICATION_ID, # replace with your bot's user ID
73
- intents=discord.set_intents(message_content=True),
74
- prefix='!' # your custom prefix
75
- )
76
-
77
- @bot.prefix_command
78
- async def ping(bot: discord.Client, event: discord.MessageCreateEvent): # the function name is the name of the command!
79
- await event.message.send(f"Pong!")
80
-
81
- bot.run()
82
- ```
83
-
84
- ## Like what you see?
85
- See the [docs](https://furmissile.github.io/scurrypy) for more!