Skip to content

Commit

Permalink
Merge branch 'stable' into unstable
Browse files Browse the repository at this point in the history
Signed-off-by: LordOfPolls <dev@lordofpolls.com>
  • Loading branch information
LordOfPolls authored Jul 7, 2023
2 parents 8b6415b + 12d7053 commit 074f867
Show file tree
Hide file tree
Showing 12 changed files with 153 additions and 70 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,6 @@
{ .annotate }

1. This connects the bot to the author's voice channel if we are not already connected
2. Check out the [Voice Support Guide](/Guides/22 Voice.html) for more info on audio playback
2. Check out the [Voice Support Guide](interactions.py/Guides/23 Voice/) for more info on audio playback

::: interactions.models.internal.active_voice_state
2 changes: 1 addition & 1 deletion docs/src/Guides/01 Getting Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ Congratulations! You now have a basic understanding of this library.
If you have any questions check out our other guides, or join the
--8<-- "discord_inv.md"

For more examples, check out the [examples page](/Guides/90 Example)
For more examples, check out the [examples page](/interactions.py/Guides/90 Example)
8 changes: 4 additions & 4 deletions docs/src/Guides/100 Migration From D.py.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@
- These work mostly the same, with a few notable changes:
- Your setup function doesn't need to do `bot.add_cog()`. Simply call `MyCog(bot)`, and it'll automatically register itself.
- Extensions already define `self.bot`, you don't need to do that in your `__init__` function.
- For a full example, see [here](/Guides/20 Extensions/)
- For a full example, see [here](/interactions.py/Guides/20 Extensions/)

4. Event handlers
- Register event handlers with `@interactions.listen`
- Where possible, we use the official names for events, most notably `on_message_create` instead of dpy's `on_message`.
- A full list can be found [here](/interactions.py/API Reference/API Reference/events/discord/).
- Event details are stored on a model, passed as a single parameter. (eg: `on_member_update(before, after)` becomes `on_member_update(event)`, where event has a `.before` and `.after`.
- `on_ready` is called whenever the gateway resumes. If you are looking to run stuff *once* upon startup, use the `on_startup` handler instead.
- For more details, read [the Events guide](/Guides/10 Events).
- For more details, read [the Events guide](/interactions.py/Guides/10 Events).

5. Migrating your commands
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/Guides/03 Creating Commands/)
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
- If you were already using dpy's command extension, migrating to slash commands is fairly simple. You just need to convert the decorators as per the [Slash Commands guide](/interactions.py/Guides/03 Creating Commands/)
- If you wish to keep using prefixed commands (sometimes called message or text-based commands), you can use our prefixed command extension, which has an [extensive guide for them](/interactions.py/Guides/07 Creating Prefixed Commands). The syntax should be very similar to discord.py with a few exceptions.
- If you were manually handling commands with `on_message`, you'll probably need to figure it out yourself, as this guide doesn't know how you wrote your parser. Consider using the provided command handlers.

???+ Note
Expand Down
2 changes: 1 addition & 1 deletion docs/src/Guides/40 Tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ To start a task that has been created, you need to run the `Task.start()` method
```
{ .annotate }

1. See [Events](/Guides/10 Events/) for more information
1. See [Events](/interactions.py/Guides/10 Events/) for more information

=== ":two: Manual Registration"

Expand Down
2 changes: 1 addition & 1 deletion docs/src/Guides/99 2.x Migration_NAFF.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ from interactions.ext import prefixed_commands
client = Client(..., intents=Intents.GUILD_MESSAGES | ...)
prefixed_commands.setup(client)
```
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/Guides/26 Prefixed Commands/).
From here it's more or less the same as before. You can find a guide on how to use prefixed commands [here](/interactions.py/Guides/26 Prefixed Commands/).

## Hybrid Commands
For now, hybrid commands are not supported, but they will be in the future.
Expand Down
192 changes: 138 additions & 54 deletions docs/src/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,58 +3,142 @@
Here you can find the changelog for the library. This is a list of all the changes that have been made to the library, since V5.0.0.
In breaking changes, the breaking change is signified by a `💥`

## 5.4.0 - May 17th, 2023
- Feat: Add regex support for modal callback
- Feat: Sort roles
- Feat: Allow .purge to return messages
- Feat: Support http proxies
- Feat: Send not ready messages if requested
- Feat: Support recovery from additional WebSocket close codes
- Fix: Properly pass guild_id to http's get_guild
- Fix: Pin our minimum version of attrs to >=22.1
- Fix: Correctly handle message references

## 5.3.1 - May 6th, 2023
- Fix: Use wrap partial on commands

## 5.3.0 - May 6th, 2023
- Feat: Add BaseEvent.client alias property
- Feat: Add `component` property to `ComponentContext`
- Feat: Add support for mentioning onboarding
- Feat: Implement new automod features
- Feat: Add missing perms
- Feat: Support audit log
- Feat: Support clyde channel flag
- Feat: Add support for voice messages
- Feat: Pass event object based on listeners signature
- Feat: `SlashCommandChoice` as parameter for `AutoCompleteContext.send`
- Fix: Add missing MessageFlag
- Fix: Account for discord's discrim change
- Fix: Copy prefixed cmd set when unloading ext
- Fix: Pass a Member as author of MessageReactionRemove
- Fix: Pass default_member_permissions in SlashCommand.group()

## 5.2.0 - April 30th, 2023
- Feat: Added `ratelimit` parameter to create thread methods
- Feat: Format ratelimit messages with major params
- Feat: Added user & member props to auto mod action
- Feat: Added poll option to jurriged ext
- Fix: Resolve failing linter checks
- Fix: Migration oversights in debug ext
- Fix: Handle a user not passing a cooldown system to the cooldown decorator

## 5.1.0 - April 21st, 2023
- Feat: Add support for regex component callbacks
- Feat: Add new audit log events to enums
- Refactor: Change log level of missing enum value from error to warning
- Feat: Add missing message types to enums
- Feat: Add support for Avatar Decorations
- Chore: Switch library license to MIT
- Build: Add pypi alias `interactions.py`
- Feat: Enhance cooldown system
- Adds new cooldown strategies and allows fetching of the cooldown object using an ID instead of context object

## 5.0.1 - April 12th, 2023
- Fix: copy checks when inheriting

## **Release 5.6.0 - June 2nd, 2023**
### What's New
- docs: Document `send_command_tracebacks` in the Error Tracking guide in https://github.com/interactions-py/interactions.py/pull/1422
- feat: add missing args to Guild.create_forum_post in https://github.com/interactions-py/interactions.py/pull/1417
- docs: fix errors in the bot example and add intent in https://github.com/interactions-py/interactions.py/pull/1416
- feat: Provide Guild ID in GuildLeft event in https://github.com/interactions-py/interactions.py/pull/1435
- feat: add support for sentry argument in https://github.com/interactions-py/interactions.py/pull/1433

### What's Fixed
- fix: correctly work with Permissions.NONE when passed into Guild.create_role in https://github.com/interactions-py/interactions.py/pull/1421
- fix: don't assume msg reference always has msg id in https://github.com/interactions-py/interactions.py/pull/1423
- fix: prevent udp ka from throwing error on close in https://github.com/interactions-py/interactions.py/pull/1425
- fix emoji.edit allowing roleslist in https://github.com/interactions-py/interactions.py/pull/1427
- fix: Don't apply guild_id to messages fetched from DM history in https://github.com/interactions-py/interactions.py/pull/1424
- fix: prevent udp ka from throwing error on close in https://github.com/interactions-py/interactions.py/pull/1425
- fix: prevent already-responded error when using discord image proxy workaround in https://github.com/interactions-py/interactions.py/commit/859323ac11ed63c3e13a2a666421b0e71d0d25d1

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.5.1...5.6.0


## **Release 5.5.1 - May 23th, 2023**
### What's Fixed
- fix: Compatibility with discord_typings 0.6.0 in https://github.com/interactions-py/interactions.py/pull/1418

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.5.0...5.5.1


## **Release 5.5.0 - May 21th, 2023**
### What's New
- feat: Handle async checks in wait_for_component in https://github.com/interactions-py/interactions.py/pull/1406
- feat: bypass discord's broken image proxy in https://github.com/interactions-py/interactions.py/pull/1414

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.4.0...5.5.0


## **Release 5.4.0 - May 17th, 2023**
### What's New
- feat: add regex support for modal callback in https://github.com/interactions-py/interactions.py/pull/1388
- feat: sort roles in https://github.com/interactions-py/interactions.py/pull/1397
- feat: allow .purge to return messages in https://github.com/interactions-py/interactions.py/pull/1396
- feat: support http proxies in https://github.com/interactions-py/interactions.py/pull/1398
- feat: send not ready messages if requested in https://github.com/interactions-py/interactions.py/pull/1389
- feat: support recovery from additional WebSocket close codes in https://github.com/interactions-py/interactions.py/pull/1403

### What's Fixed
- fix: properly pass guild_id to http's get_guild in https://github.com/interactions-py/interactions.py/pull/1394
- fix: Pin our minimum version of attrs to >=22.1 in https://github.com/interactions-py/interactions.py/pull/1392
- fix: correctly handle message references in https://github.com/interactions-py/interactions.py/pull/1395

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.3.1...5.4.0


## **Release 5.3.1 - May 6th, 2023**
- fix: use wrap partial on commands in https://github.com/interactions-py/interactions.py/pull/1391

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.3.0...5.3.1


## **Release 5.3.0 - May 6th, 2023**
### What's New
- feat: add BaseEvent.client alias property in https://github.com/interactions-py/interactions.py/pull/1368
- feat: add `component` property to `ComponentContex` in https://github.com/interactions-py/interactions.py/pull/1371
- feat: add support for mentioning onboarding in https://github.com/interactions-py/interactions.py/pull/1373
- feat: implement new automod features in https://github.com/interactions-py/interactions.py/pull/1372
- feat: add missing perms in https://github.com/interactions-py/interactions.py/pull/1374
- feat: support audit log 180 in https://github.com/interactions-py/interactions.py/pull/1379
- feat: support clyde channel flag in https://github.com/interactions-py/interactions.py/pull/1375
- feat: add support for voice messages in https://github.com/interactions-py/interactions.py/pull/1376
- feat: pass event object based on listeners signature in https://github.com/interactions-py/interactions.py/pull/1367
- feat: `SlashCommandChoice` as parameter for `AutoCompleteContext.send` in https://github.com/interactions-py/interactions.py/pull/1380

### What's Fixed
- fix: account for discord's discrim change in https://github.com/interactions-py/interactions.py/pull/1384
- fix: copy prefixed cmd set when unloading ext in https://github.com/interactions-py/interactions.py/pull/1385
- fix: pass a Member as author of MessageReactionRemove in https://github.com/interactions-py/interactions.py/pull/1370
- fix: pass default_member_permissions in SlashCommand.group() in https://github.com/interactions-py/interactions.py/pull/1369

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.2.0...5.3.0


## **Release 5.2.0 - April 30th, 2023**
### What's New
- feat: add `rate_limit_per_user` param for create thread methods in https://github.com/interactions-py/interactions.py/pull/1359
- feat: format ratelimit messages with major params in https://github.com/interactions-py/interactions.py/pull/1360
- feat: add `user` & `member` props to auto mod action in https://github.com/interactions-py/interactions.py/pull/1358
- Added poll option to jurriged ext by @Proxy in https://github.com/interactions-py/interactions.py/pull/1364

### What's Fixed
- fix: Resolve failing linter checks in https://github.com/interactions-py/interactions.py/pull/1361
- fix migration oversights in debug ext
- fix: handle a user not passing a cooldown system to the cooldown decorator

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.1.0...5.2.0


## **Release 5.1.0 - April 21st, 2023**
### What's New
- feat: support regex component callbacks in https://github.com/interactions-py/interactions.py/pull/1332
- chore: switch to MIT license in https://github.com/interactions-py/interactions.py/pull/1334
- feat: add audit new mod events to audit log enum in https://github.com/interactions-py/interactions.py/pull/1335
- refactor: change log level of missing value to warning in https://github.com/interactions-py/interactions.py/pull/1339
- feat: add missing message types in https://github.com/interactions-py/interactions.py/pull/1338
- feat: support avatar decorations in https://github.com/interactions-py/interactions.py/pull/1329
- feat: sync improvements in https://github.com/interactions-py/interactions.py/pull/1328
- feat: rate limit improvements in https://github.com/interactions-py/interactions.py/pull/1321
- refactor: Update readme shields and add recent extensions in https://github.com/interactions-py/interactions.py/pull/1348
- feat: caching improvements in https://github.com/interactions-py/interactions.py/pull/1350
- feat: add reset_with_key and get_cooldown_time_with_key in https://github.com/interactions-py/interactions.py/pull/1345
- docs: adjust and fix many parts of the docs in https://github.com/interactions-py/interactions.py/pull/1353

### What's Fixed
- fix: wrong check condition in the component callback in https://github.com/interactions-py/interactions.py/pull/1352
- chore: Update filesize to new 25mb discord limit in https://github.com/interactions-py/interactions.py/pull/1346

**Full Changelog:** https://github.com/interactions-py/interactions.py/compare/5.0.1...5.1.0


## **Release 5.0.1 - HOTFIX - April 12th, 2023**
- fix: copy checks when inheriting
- When inheriting checks, slash commands would pass in their own checks to the subcommand. This makes sense logically, however, what wasn't being caught was that these were being passed by reference, and so any edit to the checks in one subcommand would affect potentially EVERY command.
- Build: Ensure opus `dll`s are included in pypi releases
- build: Ensure opus `dll`s are included in pypi releases


## **Release 5.0.0 - April 10th, 2023**
- Python3.10 is now the minimum supported python version
- The cache takes centre stage - accessing client.http should not be required
- The client is now substantially more error tolerant. Your commands can fail spectacularly, and the client wont drop an event
- Full API coverage (excluding some pre-release bits)
- Voice Playback and recording built-in
vMany of the old exts are now merged in (check out [here](https://github.com/interactions-py/interactions.py/tree/5.0.0/interactions/ext))
- Performance is improved
- UX has subjectively improved - this is because this release was based heavily on feedback from users

Docs: https://interactions-py.github.io/interactions.py/<br/>
For NAFF users: [NAFF Migration Guide](https://interactions-py.github.io/interactions.py/Guides/99%202.x%20Migration_NAFF/)<br/>
For i.py v4: [I.PY V4 Migration Guide](https://interactions-py.github.io/interactions.py/Guides/98%20Migration%20from%204.X/)<br/>

Full Changelog https://github.com/interactions-py/interactions.py/compare/4.4.0...5.0.0
2 changes: 0 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ hide:
- toc
- feedback
---
!!! danger "Remember"
These docs are not completed. Please do not panic if something is missing or inaccurate.

We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++.

Expand Down
2 changes: 1 addition & 1 deletion interactions/ext/jurigged.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
)
except ModuleNotFoundError:
get_logger().error(
"jurigged not installed, cannot enable jurigged integration. Install with `pip install interactions[jurigged]`"
"jurigged not installed, cannot enable jurigged integration. Install with `pip install discord-py-interactions[jurigged]`"
)
raise

Expand Down
2 changes: 1 addition & 1 deletion interactions/ext/sentry.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
import sentry_sdk
except ModuleNotFoundError:
get_logger().error(
"sentry-sdk not installed, cannot enable sentry integration. Install with `pip install interactions[sentry]`"
"sentry-sdk not installed, cannot enable sentry integration. Install with `pip install discord-py-interactions[sentry]`"
)
raise

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,16 @@ plugins:
handlers:
python:
selection:
inherited_members: true
inherited_members: True
filters:
- "!^_"
rendering:
members_order: source
show_bases: True
show_root_toc_entry: False
group_by_category: False
group_by_category: True
heading_level: 3
show_if_no_docstring: False # temporary, this will be reverted to False once we're done with docs
show_if_no_docstring: True
- minify:
minify_html: true
# keep this at the bottom of the plugins list - if you are building without insiders, comment it out
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "interactions.py"
version = "5.6.0"
version = "5.7.0"
description = "Easy, simple, scalable and modular: a Python API wrapper for interactions."
authors = [
"LordOfPolls <dev@lordofpolls.com>",
Expand Down
1 change: 1 addition & 0 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
"mkdocs-minify-plugin",
"mkdocs-git-committers-plugin-2",
"mkdocs-git-revision-date-localized-plugin",
"griffe==0.25",
]
extras_require["tests"] = [
"pytest",
Expand Down

0 comments on commit 074f867

Please sign in to comment.