Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

General Cleanup #9

Merged
merged 7 commits into from
Feb 18, 2024
Merged

General Cleanup #9

merged 7 commits into from
Feb 18, 2024

Conversation

seekheart
Copy link
Owner

Updated documentation for v1.0.0 release and added changelog to track features/bugfixes. Cleaned up code and refactored logging to use loguru native configuration by environment variables.

- updated return signatures to match doc string and type hints
- removed unused imports
- updated return signatures to match doc string and type hints
- removed unused imports
- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var
- updated `.env` file variables
… more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object
@seekheart seekheart added feature request New feature or request devops Tasks relating to DevOps labels Feb 18, 2024
@seekheart seekheart added this to the Jainy Bot v1.0.0 Release milestone Feb 18, 2024
@seekheart seekheart self-assigned this Feb 18, 2024
@seekheart seekheart merged commit c1e0087 into develop Feb 18, 2024
1 check passed
@seekheart seekheart deleted the documentation/general-docs branch February 18, 2024 18:11
seekheart added a commit that referenced this pull request Feb 18, 2024
* added github workflow to build docker images on PR file

- added `.github` folder and `workflow` folder to house github actions
- setup workflow to build docker image for jainy_bot with date

* added github action for building and publishing jobs

- added workflow for publishing tagged docker images
- added workflow for testing builds with git commit hash (short variant)

* changing secrets path to see if path was wrong

- removed secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- added back secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- removed secret name, and in github settings made each secret separate input

* added new bot command to track uptime and tidied up some code (#5)

- fixed type hint for ctx in borb.py
- added new uptime class cog
- updated commands package __init__.py to include cogs list for use in auto registration with bot.py
- updated bot.py to auto register cogs

* added new github action to handle tagging (#6)

- added github-tag-action to handle tagging version
- removed env declaration and tag variable

* Create LICENSE

* added feature request template for issues, and updated LICENSE template with name and copyright year (#7)

- added LICENSE template details
- added git issue template for features

* Adding moderation cog and commands (#8)

* added moderation cog with kick command, added new configuration properties to borb_bot config

- updated commands cog list to include new cog
- added moderation cog with kick command and embed message helper
- updated borb_bot config to include moderator roles and audit channel id

* added ban, unban, clean, invite commands, and added custom exception

- added ban, unban, clean, invite commands to moderation cog
- updated doc strings
- added helper functions to make embed messages for auditing
- created custom exception for when user unauthorized to use command

* refactored clean command to properly purge msg by user and correct amount

- refactored clean command to correctly purge messages by user
- set default limit of 1000 messages to look through
- added bot reply for cleaned messages

* added docstrings, refactored helper functions in to util file to be shared across cogs

- added docstrings to methods and functions
- refactored helpers from moderation cog to util file for shared use

* General Cleanup (#9)

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* updated configuration and corrected null check

- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var

* added changelog with notes on release

* fixed casing on moderator_roles to MODERATOR_ROLES

* updated readme

- updated `.env` file variables

* removed logging.py in favor of env var setup for loguru logger, added more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object

* updated readme

- added loguru env var for setting log level

* fixed small error being thrown when initial bot command msg gets deleted before cleanup

* cleaned up unused variables, and added more logging

- removed unused os.environ from react_roles since var isn't used
- added logging to uptime command
seekheart added a commit that referenced this pull request May 4, 2024
* added github workflow to build docker images on PR file

- added `.github` folder and `workflow` folder to house github actions
- setup workflow to build docker image for jainy_bot with date

* added github action for building and publishing jobs

- added workflow for publishing tagged docker images
- added workflow for testing builds with git commit hash (short variant)

* changing secrets path to see if path was wrong

- removed secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- added back secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- removed secret name, and in github settings made each secret separate input

* added new bot command to track uptime and tidied up some code (#5)

- fixed type hint for ctx in borb.py
- added new uptime class cog
- updated commands package __init__.py to include cogs list for use in auto registration with bot.py
- updated bot.py to auto register cogs

* added new github action to handle tagging (#6)

- added github-tag-action to handle tagging version
- removed env declaration and tag variable

* Create LICENSE

* added feature request template for issues, and updated LICENSE template with name and copyright year (#7)

- added LICENSE template details
- added git issue template for features

* Adding moderation cog and commands (#8)

* added moderation cog with kick command, added new configuration properties to borb_bot config

- updated commands cog list to include new cog
- added moderation cog with kick command and embed message helper
- updated borb_bot config to include moderator roles and audit channel id

* added ban, unban, clean, invite commands, and added custom exception

- added ban, unban, clean, invite commands to moderation cog
- updated doc strings
- added helper functions to make embed messages for auditing
- created custom exception for when user unauthorized to use command

* refactored clean command to properly purge msg by user and correct amount

- refactored clean command to correctly purge messages by user
- set default limit of 1000 messages to look through
- added bot reply for cleaned messages

* added docstrings, refactored helper functions in to util file to be shared across cogs

- added docstrings to methods and functions
- refactored helpers from moderation cog to util file for shared use

* General Cleanup (#9)

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* updated configuration and corrected null check

- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var

* added changelog with notes on release

* fixed casing on moderator_roles to MODERATOR_ROLES

* updated readme

- updated `.env` file variables

* removed logging.py in favor of env var setup for loguru logger, added more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object

* Release/v1.0.0 (#11)

* updated readme

- added loguru env var for setting log level

* fixed small error being thrown when initial bot command msg gets deleted before cleanup

* cleaned up unused variables, and added more logging

- removed unused os.environ from react_roles since var isn't used
- added logging to uptime command

* Bump aiohttp from 3.9.3 to 3.9.4 (#13)

Bumps [aiohttp](https://github.com/aio-libs/aiohttp) from 3.9.3 to 3.9.4.
- [Release notes](https://github.com/aio-libs/aiohttp/releases)
- [Changelog](https://github.com/aio-libs/aiohttp/blob/master/CHANGES.rst)
- [Commits](aio-libs/aiohttp@v3.9.3...v3.9.4)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump idna from 3.6 to 3.7 (#12)

Bumps [idna](https://github.com/kjd/idna) from 3.6 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](kjd/idna@v3.6...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Dalle Feature (#15)

* updated requirements.txt and added dalle command and config.

- added dalle command to generate random images
- added config file for dalle api communication
- added requests dep for network api calls

* cleaned up dockerfile

- removed env vars since they get defined in compose

* cleaned up moderation py to use audit channel and updated dalle to let user know prompt successful

- dalle command lets user know prompt was received now
- moderation command uses the audit channel in addition to native discord audit of mod commands

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
seekheart added a commit that referenced this pull request May 4, 2024
* Release/v1.0.0 (#10)

* added github workflow to build docker images on PR file

- added `.github` folder and `workflow` folder to house github actions
- setup workflow to build docker image for jainy_bot with date

* added github action for building and publishing jobs

- added workflow for publishing tagged docker images
- added workflow for testing builds with git commit hash (short variant)

* changing secrets path to see if path was wrong

- removed secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- added back secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- removed secret name, and in github settings made each secret separate input

* added new bot command to track uptime and tidied up some code (#5)

- fixed type hint for ctx in borb.py
- added new uptime class cog
- updated commands package __init__.py to include cogs list for use in auto registration with bot.py
- updated bot.py to auto register cogs

* added new github action to handle tagging (#6)

- added github-tag-action to handle tagging version
- removed env declaration and tag variable

* Create LICENSE

* added feature request template for issues, and updated LICENSE template with name and copyright year (#7)

- added LICENSE template details
- added git issue template for features

* Adding moderation cog and commands (#8)

* added moderation cog with kick command, added new configuration properties to borb_bot config

- updated commands cog list to include new cog
- added moderation cog with kick command and embed message helper
- updated borb_bot config to include moderator roles and audit channel id

* added ban, unban, clean, invite commands, and added custom exception

- added ban, unban, clean, invite commands to moderation cog
- updated doc strings
- added helper functions to make embed messages for auditing
- created custom exception for when user unauthorized to use command

* refactored clean command to properly purge msg by user and correct amount

- refactored clean command to correctly purge messages by user
- set default limit of 1000 messages to look through
- added bot reply for cleaned messages

* added docstrings, refactored helper functions in to util file to be shared across cogs

- added docstrings to methods and functions
- refactored helpers from moderation cog to util file for shared use

* General Cleanup (#9)

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* updated configuration and corrected null check

- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var

* added changelog with notes on release

* fixed casing on moderator_roles to MODERATOR_ROLES

* updated readme

- updated `.env` file variables

* removed logging.py in favor of env var setup for loguru logger, added more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object

* updated readme

- added loguru env var for setting log level

* fixed small error being thrown when initial bot command msg gets deleted before cleanup

* cleaned up unused variables, and added more logging

- removed unused os.environ from react_roles since var isn't used
- added logging to uptime command

* cleaned up moderation py to use audit channel and updated dalle to let user know prompt successful

- dalle command lets user know prompt was received now
- moderation command uses the audit channel in addition to native discord audit of mod commands
seekheart added a commit that referenced this pull request May 7, 2024
* Release/v1.0.0 (#10)

* added github workflow to build docker images on PR file

- added `.github` folder and `workflow` folder to house github actions
- setup workflow to build docker image for jainy_bot with date

* added github action for building and publishing jobs

- added workflow for publishing tagged docker images
- added workflow for testing builds with git commit hash (short variant)

* changing secrets path to see if path was wrong

- removed secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- added back secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- removed secret name, and in github settings made each secret separate input

* added new bot command to track uptime and tidied up some code (#5)

- fixed type hint for ctx in borb.py
- added new uptime class cog
- updated commands package __init__.py to include cogs list for use in auto registration with bot.py
- updated bot.py to auto register cogs

* added new github action to handle tagging (#6)

- added github-tag-action to handle tagging version
- removed env declaration and tag variable

* Create LICENSE

* added feature request template for issues, and updated LICENSE template with name and copyright year (#7)

- added LICENSE template details
- added git issue template for features

* Adding moderation cog and commands (#8)

* added moderation cog with kick command, added new configuration properties to borb_bot config

- updated commands cog list to include new cog
- added moderation cog with kick command and embed message helper
- updated borb_bot config to include moderator roles and audit channel id

* added ban, unban, clean, invite commands, and added custom exception

- added ban, unban, clean, invite commands to moderation cog
- updated doc strings
- added helper functions to make embed messages for auditing
- created custom exception for when user unauthorized to use command

* refactored clean command to properly purge msg by user and correct amount

- refactored clean command to correctly purge messages by user
- set default limit of 1000 messages to look through
- added bot reply for cleaned messages

* added docstrings, refactored helper functions in to util file to be shared across cogs

- added docstrings to methods and functions
- refactored helpers from moderation cog to util file for shared use

* General Cleanup (#9)

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* updated configuration and corrected null check

- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var

* added changelog with notes on release

* fixed casing on moderator_roles to MODERATOR_ROLES

* updated readme

- updated `.env` file variables

* removed logging.py in favor of env var setup for loguru logger, added more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object

* updated readme

- added loguru env var for setting log level

* fixed small error being thrown when initial bot command msg gets deleted before cleanup

* cleaned up unused variables, and added more logging

- removed unused os.environ from react_roles since var isn't used
- added logging to uptime command

* Release v1.1.0 (#16)

* added github workflow to build docker images on PR file

- added `.github` folder and `workflow` folder to house github actions
- setup workflow to build docker image for jainy_bot with date

* added github action for building and publishing jobs

- added workflow for publishing tagged docker images
- added workflow for testing builds with git commit hash (short variant)

* changing secrets path to see if path was wrong

- removed secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- added back secret name and used env var defined in secret instead

* changing secrets path to see if path was wrong

- removed secret name, and in github settings made each secret separate input

* added new bot command to track uptime and tidied up some code (#5)

- fixed type hint for ctx in borb.py
- added new uptime class cog
- updated commands package __init__.py to include cogs list for use in auto registration with bot.py
- updated bot.py to auto register cogs

* added new github action to handle tagging (#6)

- added github-tag-action to handle tagging version
- removed env declaration and tag variable

* Create LICENSE

* added feature request template for issues, and updated LICENSE template with name and copyright year (#7)

- added LICENSE template details
- added git issue template for features

* Adding moderation cog and commands (#8)

* added moderation cog with kick command, added new configuration properties to borb_bot config

- updated commands cog list to include new cog
- added moderation cog with kick command and embed message helper
- updated borb_bot config to include moderator roles and audit channel id

* added ban, unban, clean, invite commands, and added custom exception

- added ban, unban, clean, invite commands to moderation cog
- updated doc strings
- added helper functions to make embed messages for auditing
- created custom exception for when user unauthorized to use command

* refactored clean command to properly purge msg by user and correct amount

- refactored clean command to correctly purge messages by user
- set default limit of 1000 messages to look through
- added bot reply for cleaned messages

* added docstrings, refactored helper functions in to util file to be shared across cogs

- added docstrings to methods and functions
- refactored helpers from moderation cog to util file for shared use

* General Cleanup (#9)

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* tidied up code to match return signatures and doc strings

- updated return signatures to match doc string and type hints
- removed unused imports

* updated configuration and corrected null check

- fixed null check to check for correct env var for MOD_AUDIT_CHANNEL_ID and made moderator_roles into env var

* added changelog with notes on release

* fixed casing on moderator_roles to MODERATOR_ROLES

* updated readme

- updated `.env` file variables

* removed logging.py in favor of env var setup for loguru logger, added more exception handling

- removed logging.py in favor of using loguru environment variables to set the logging level
- updated kick command to check for UserNotFound exception thrown by commands object

* Release/v1.0.0 (#11)

* updated readme

- added loguru env var for setting log level

* fixed small error being thrown when initial bot command msg gets deleted before cleanup

* cleaned up unused variables, and added more logging

- removed unused os.environ from react_roles since var isn't used
- added logging to uptime command

* Bump aiohttp from 3.9.3 to 3.9.4 (#13)

Bumps [aiohttp](https://github.com/aio-libs/aiohttp) from 3.9.3 to 3.9.4.
- [Release notes](https://github.com/aio-libs/aiohttp/releases)
- [Changelog](https://github.com/aio-libs/aiohttp/blob/master/CHANGES.rst)
- [Commits](aio-libs/aiohttp@v3.9.3...v3.9.4)

---
updated-dependencies:
- dependency-name: aiohttp
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Bump idna from 3.6 to 3.7 (#12)

Bumps [idna](https://github.com/kjd/idna) from 3.6 to 3.7.
- [Release notes](https://github.com/kjd/idna/releases)
- [Changelog](https://github.com/kjd/idna/blob/master/HISTORY.rst)
- [Commits](kjd/idna@v3.6...v3.7)

---
updated-dependencies:
- dependency-name: idna
  dependency-type: direct:production
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Dalle Feature (#15)

* updated requirements.txt and added dalle command and config.

- added dalle command to generate random images
- added config file for dalle api communication
- added requests dep for network api calls

* cleaned up dockerfile

- removed env vars since they get defined in compose

* cleaned up moderation py to use audit channel and updated dalle to let user know prompt successful

- dalle command lets user know prompt was received now
- moderation command uses the audit channel in addition to native discord audit of mod commands

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* fixed issue with synchronous code killing discord healthcheck and crashing bot.

- removed requests library in favor of aiohttp for asynchronous requests
- updated dalle logic to work with change
- updated dependencies

* fixed issue with synchronous code killing discord healthcheck and crashing bot.

- removed requests library in favor of aiohttp for asynchronous requests
- updated dalle logic to work with change
- updated dependencies

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
devops Tasks relating to DevOps feature request New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant