Skip to content

Commit

Permalink
chore: apply pre-commit, pyright
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobCoffee committed Feb 28, 2024
1 parent 7792176 commit 4c3de6a
Show file tree
Hide file tree
Showing 18 changed files with 1,821 additions and 2,964 deletions.
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
*.min.*
.git/COMMIT_EDITMSG
14 changes: 13 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
{
"singleAttributePerLine": true
"arrowParens": "avoid",
"bracketSpacing": true,
"htmlWhitespaceSensitivity": "ignore",
"insertPragma": false,
"printWidth": 120,
"proseWrap": "always",
"quoteProps": "as-needed",
"requirePragma": false,
"semi": false,
"singleQuote": false,
"trailingComma": "all",
"useTabs": false,
"bracketSameLine": true
}
26 changes: 11 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,8 @@
<!-- ALL-CONTRIBUTORS-BADGE:END -->

> [!WARNING]\
> This repository holds very broken code.
> It is not recommended to use this code in any way.
> It is currently being used to learn the creation of a Discord bot, used by developers
> to enhance their community/guild experience with features like
> This repository holds very broken code. It is not recommended to use this code in any way. It is currently being used to
> learn the creation of a Discord bot, used by developers to enhance their community/guild experience with features like
>
> - GitHub integration
> - Upload Threads/Forum Posts to GitHub discussions
Expand All @@ -30,19 +28,18 @@ The Discord bot is built on the [Discord.py v2][discordpy] library.

## Web

The web service is a [Litestar][litestar] application. It is utilizing [Jinja2][jinja] templating, [TailwindCSS][tailwind],
[DaisyUI][daisy], and [Feather icons][feather] for the front end, and the backend is using the Litestar-provided
utilities for routing, middleware, and more.
The web service is a [Litestar][litestar] application. It is utilizing [Jinja2][jinja] templating,
[TailwindCSS][tailwind], [DaisyUI][daisy], and [Feather icons][feather] for the front end, and the backend is using the
Litestar-provided utilities for routing, middleware, and more.

## Deployment

Byte is currently deployed to [Railway][railway] for both the bot and the web service in production
and testing.
Byte is currently deployed to [Railway][railway] for both the bot and the web service in production and testing.

## Development

You can use the provided [nixpack][nixpacks] config [file](./nixpacks.toml) config,
or set up your environment using PDM[pdm].
You can use the provided [nixpack][nixpacks] config [file](./nixpacks.toml) config, or set up your environment using
PDM[pdm].

## Contributing

Expand All @@ -51,9 +48,7 @@ All contributions are welcome! Please see [CONTRIBUTING](./CONTRIBUTING.rst) for
<details>
<summary>### UI Examples</summary>

![Home](docs/images/home.png)
![Dark Home](docs/images/dark-home.png)
![Dashboard](docs/images/dashboard.png)
![Home](docs/images/home.png) ![Dark Home](docs/images/dark-home.png) ![Dashboard](docs/images/dashboard.png)
![API - Elements](docs/images/api-elements.png)

</details>
Expand Down Expand Up @@ -90,4 +85,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification.
Contributions of any kind welcome!
3 changes: 2 additions & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ We will ensure that your finding gets escalated to the appropriate maintainer(s)

**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**

If you believe you have found a security vulnerability in any of my repositories, please report it to us through coordinated disclosure:
If you believe you have found a security vulnerability in any of my repositories, please report it to us through
coordinated disclosure:

- In the affected repository, browse to the **Security** tab, select **Advisories**, select "Report a vulnerability"
- ![image](https://user-images.githubusercontent.com/45884264/217041010-8fd6b96b-329d-4d8e-8838-9b5bf4e1a78d.png)
Expand Down
1 change: 0 additions & 1 deletion src/byte/plugins/forums.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
from discord import Embed, Interaction, Member, Thread
from discord.app_commands import command as app_command
from discord.ext.commands import Bot, Cog, Context, command, hybrid_command
from discord.types.channel import ForumChannel

from byte.lib.common import litestar_logo_yellow, mcve
from byte.lib.utils import linker
Expand Down
Loading

0 comments on commit 4c3de6a

Please sign in to comment.