diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..e571bcf
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,5 @@
+build:
+ docker build -t droidzed/disco-hooker:latest .
+
+run:
+ py app.py
\ No newline at end of file
diff --git a/Pipfile b/Pipfile
index 7a7f1a2..73bfe4c 100644
--- a/Pipfile
+++ b/Pipfile
@@ -16,7 +16,7 @@ pylint = "*"
isort = {extras = ["pipfile_deprecated_finder"], version = "*"}
[requires]
-python_version = "3.11"
+python_version = "3.12"
[pipenv]
allow_prereleases = false
diff --git a/Pipfile.lock b/Pipfile.lock
index 3c11517..ee93f95 100644
--- a/Pipfile.lock
+++ b/Pipfile.lock
@@ -1,11 +1,11 @@
{
"_meta": {
"hash": {
- "sha256": "3e9a9bc29e3fd9cb794b45cf50387cafe981a0295de75d6667b847f4a524d71a"
+ "sha256": "55c3107357eef041d414bf4e5c60ec4725b904888815777cd37c19f57ed7de53"
},
"pipfile-spec": 6,
"requires": {
- "python_version": "3.11"
+ "python_version": "3.12"
},
"sources": [
{
@@ -18,11 +18,11 @@
"default": {
"anyio": {
"hashes": [
- "sha256:cfdb2b588b9fc25ede96d8db56ed50848b0b649dca3dd1df0b11f683bb9e0b5f",
- "sha256:f7ed51751b2c2add651e5747c891b47e26d2a21be5d32d9311dfe9692f3e5d7a"
+ "sha256:56a415fbc462291813a94528a779597226619c8e78af7de0507333f700011e5f",
+ "sha256:5a0bec7085176715be77df87fc66d6c9d70626bd752fcc85f57cdbee5b3760da"
],
"markers": "python_version >= '3.8'",
- "version": "==4.0.0"
+ "version": "==4.1.0"
},
"asgiref": {
"hashes": [
@@ -41,11 +41,11 @@
},
"certifi": {
"hashes": [
- "sha256:539cc1d13202e33ca466e88b2807e29f4c13049d6d87031a3c110744495cb082",
- "sha256:92d6037539857d8206b8f6ae472e8b77db8058fec5937a1ef3f54304089edbb9"
+ "sha256:9b469f3a900bf28dc19b8cfbf8019bf47f7fdd1a65a1d4ffb98fc14166beb4d1",
+ "sha256:e036ab49d5b79556f99cfc2d9320b34cfbe5be05c5871b51de9329f0603b0474"
],
"markers": "python_version >= '3.6'",
- "version": "==2023.7.22"
+ "version": "==2023.11.17"
},
"charset-normalizer": {
"hashes": [
@@ -167,8 +167,7 @@
"sha256:1d44e6caf81810c5ebe6e2363a6fefee2cab915ad4c2e843a0ec088b0e54ed51",
"sha256:666d57037620feff6fd0f6930714201eee8ca279003d3d217c1ad0ca0049e93b"
],
- "index": "pypi",
- "markers": null,
+ "markers": "python_version >= '3.8' and python_version < '4.0'",
"version": "==1.3.0"
},
"flask": {
@@ -179,8 +178,7 @@
"sha256:21128f47e4e3b9d597a3e8521a329bf56909b690fcc3fa3e477725aa81367638",
"sha256:cfadcdb638b609361d29ec22360d6070a77d7463dcb3ab08d2c2f2f168845f58"
],
- "index": "pypi",
- "markers": null,
+ "markers": "python_version >= '3.8'",
"version": "==3.0.0"
},
"h11": {
@@ -208,11 +206,11 @@
},
"idna": {
"hashes": [
- "sha256:814f528e8dead7d329833b91c5faa87d60bf71824cd12a7530b5526063d02cb4",
- "sha256:90b77e79eaa3eba6de819a0c442c0b4ceefc341a7a2ab77d7562bf49f425c5c2"
+ "sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca",
+ "sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f"
],
"markers": "python_version >= '3.5'",
- "version": "==3.4"
+ "version": "==3.6"
},
"itsdangerous": {
"hashes": [
@@ -332,11 +330,11 @@
},
"urllib3": {
"hashes": [
- "sha256:c97dfde1f7bd43a71c8d2a58e369e9b2bf692d1334ea9f9cae55add7d0dd0f84",
- "sha256:fdb6d215c776278489906c2f8916e6e7d4f5a9b602ccbcfdf7f016fc8da0596e"
+ "sha256:55901e917a5896a349ff771be919f8bd99aff50b79fe58fec595eb37bbc56bb3",
+ "sha256:df7aa8afb0148fa78488e7899b2c59b5f4ffcfa82e6c54ccb9dd37c1d7b52d54"
],
- "markers": "python_version >= '3.7'",
- "version": "==2.0.7"
+ "markers": "python_version >= '3.8'",
+ "version": "==2.1.0"
},
"waitress": {
"hashes": [
@@ -344,6 +342,7 @@
"sha256:780a4082c5fbc0fde6a2fcfe5e26e6efc1e8f425730863c04085769781f51eba"
],
"index": "pypi",
+ "markers": "python_full_version >= '3.7.0'",
"version": "==2.1.2"
},
"werkzeug": {
@@ -366,27 +365,32 @@
},
"black": {
"hashes": [
- "sha256:250d7e60f323fcfc8ea6c800d5eba12f7967400eb6c2d21ae85ad31c204fb1f4",
- "sha256:2a9acad1451632021ee0d146c8765782a0c3846e0e0ea46659d7c4f89d9b212b",
- "sha256:412f56bab20ac85927f3a959230331de5614aecda1ede14b373083f62ec24e6f",
- "sha256:421f3e44aa67138ab1b9bfbc22ee3780b22fa5b291e4db8ab7eee95200726b07",
- "sha256:45aa1d4675964946e53ab81aeec7a37613c1cb71647b5394779e6efb79d6d187",
- "sha256:4c44b7211a3a0570cc097e81135faa5f261264f4dfaa22bd5ee2875a4e773bd6",
- "sha256:4c68855825ff432d197229846f971bc4d6666ce90492e5b02013bcaca4d9ab05",
- "sha256:5133f5507007ba08d8b7b263c7aa0f931af5ba88a29beacc4b2dc23fcefe9c06",
- "sha256:54caaa703227c6e0c87b76326d0862184729a69b73d3b7305b6288e1d830067e",
- "sha256:58e5f4d08a205b11800332920e285bd25e1a75c54953e05502052738fe16b3b5",
- "sha256:698c1e0d5c43354ec5d6f4d914d0d553a9ada56c85415700b81dc90125aac244",
- "sha256:6c1cac07e64433f646a9a838cdc00c9768b3c362805afc3fce341af0e6a9ae9f",
- "sha256:760415ccc20f9e8747084169110ef75d545f3b0932ee21368f63ac0fee86b221",
- "sha256:7f622b6822f02bfaf2a5cd31fdb7cd86fcf33dab6ced5185c35f5db98260b055",
- "sha256:cf57719e581cfd48c4efe28543fea3d139c6b6f1238b3f0102a9c73992cbb479",
- "sha256:d136ef5b418c81660ad847efe0e55c58c8208b77a57a28a503a5f345ccf01394",
- "sha256:dbea0bb8575c6b6303cc65017b46351dc5953eea5c0a59d7b7e3a2d2f433a911",
- "sha256:fc7f6a44d52747e65a02558e1d807c82df1d66ffa80a601862040a43ec2e3142"
+ "sha256:12d5f10cce8dc27202e9a252acd1c9a426c83f95496c959406c96b785a92bb7d",
+ "sha256:193946e634e80bfb3aec41830f5d7431f8dd5b20d11d89be14b84a97c6b8bc75",
+ "sha256:330a327b422aca0634ecd115985c1c7fd7bdb5b5a2ef8aa9888a82e2ebe9437a",
+ "sha256:39dda060b9b395a6b7bf9c5db28ac87b3c3f48d4fdff470fa8a94ab8271da47e",
+ "sha256:593596f699ca2dcbbbdfa59fcda7d8ad6604370c10228223cd6cf6ce1ce7ed7e",
+ "sha256:67f19562d367468ab59bd6c36a72b2c84bc2f16b59788690e02bbcb140a77175",
+ "sha256:6a82a711d13e61840fb11a6dfecc7287f2424f1ca34765e70c909a35ffa7fb95",
+ "sha256:7231670266ca5191a76cb838185d9be59cfa4f5dd401b7c1c70b993c58f6b1b5",
+ "sha256:72db37a2266b16d256b3ea88b9affcdd5c41a74db551ec3dd4609a59c17d25bf",
+ "sha256:81a832b6e00eef2c13b3239d514ea3b7d5cc3eaa03d0474eedcbbda59441ba5d",
+ "sha256:97af22278043a6a1272daca10a6f4d36c04dfa77e61cbaaf4482e08f3640e9f0",
+ "sha256:996650a89fe5892714ea4ea87bc45e41a59a1e01675c42c433a35b490e5aa3f0",
+ "sha256:a7c07db8200b5315dc07e331dda4d889a56f6bf4db6a9c2a526fa3166a81614f",
+ "sha256:ace64c1a349c162d6da3cef91e3b0e78c4fc596ffde9413efa0525456148873d",
+ "sha256:ba09cae1657c4f8a8c9ff6cfd4a6baaf915bb4ef7d03acffe6a2f6585fa1bd01",
+ "sha256:bbd75d9f28a7283b7426160ca21c5bd640ca7cd8ef6630b4754b6df9e2da8462",
+ "sha256:bcf91b01ddd91a2fed9a8006d7baa94ccefe7e518556470cf40213bd3d44bbbc",
+ "sha256:bdbff34c487239a63d86db0c9385b27cdd68b1bfa4e706aa74bb94a435403672",
+ "sha256:c71048345bdbced456cddf1622832276d98a710196b842407840ae8055ade6ee",
+ "sha256:e73c5e3d37e5a3513d16b33305713237a234396ae56769b839d7c40759b8a41c",
+ "sha256:ead25c273adfad1095a8ad32afdb8304933efba56e3c1d31b0fee4143a1e424a",
+ "sha256:fdf6f23c83078a6c8da2442f4d4eeb19c28ac2a6416da7671b72f0295c4a697b"
],
"index": "pypi",
- "version": "==23.11.0"
+ "markers": "python_version >= '3.8'",
+ "version": "==23.12.0"
},
"cfgv": {
"hashes": [
@@ -422,10 +426,10 @@
},
"distlib": {
"hashes": [
- "sha256:2e24928bc811348f0feb63014e97aaae3037f2cf48712d51ae61df7fd6075057",
- "sha256:9dafe54b34a028eafd95039d5e5d4851a13734540f1331060d31c9916e7147a8"
+ "sha256:034db59a0b96f8ca18035f36290806a9a6e6bd9d1ff91e45a7f172eb17e51784",
+ "sha256:1530ea13e350031b6312d8580ddb6b27a104275a31106523b8f123787f494f64"
],
- "version": "==0.3.7"
+ "version": "==0.3.8"
},
"filelock": {
"hashes": [
@@ -437,23 +441,22 @@
},
"identify": {
"hashes": [
- "sha256:7736b3c7a28233637e3c36550646fc6389bedd74ae84cb788200cc8e2dd60b75",
- "sha256:90199cb9e7bd3c5407a9b7e81b4abec4bb9d249991c79439ec8af740afc6293d"
+ "sha256:161558f9fe4559e1557e1bff323e8631f6a0e4837f7497767c1782832f16b62d",
+ "sha256:d40ce5fcd762817627670da8a7d8d8e65f24342d14539c59488dc603bf662e34"
],
"markers": "python_version >= '3.8'",
- "version": "==2.5.31"
+ "version": "==2.5.33"
},
"isort": {
"extras": [
"pipfile_deprecated_finder"
],
"hashes": [
- "sha256:8bef7dde241278824a6d83f44a544709b065191b95b6e50894bdc722fcba0504",
- "sha256:f84c2818376e66cf843d497486ea8fed8700b340f308f076c6fb1229dff318b6"
+ "sha256:56a51732c25f94ca96f6721be206dd96a95f42950502eb26c1015d333bc6edb7",
+ "sha256:aaed790b463e8703fb1eddb831dfa8e8616bacde2c083bd557ef73c8189b7263"
],
- "index": "pypi",
- "markers": null,
- "version": "==5.12.0"
+ "markers": "python_full_version >= '3.8.0'",
+ "version": "==5.13.1"
},
"mccabe": {
"hashes": [
@@ -489,35 +492,37 @@
},
"pathspec": {
"hashes": [
- "sha256:1d6ed233af05e679efb96b1851550ea95bbb64b7c490b0f5aa52996c11e92a20",
- "sha256:e0d8d0ac2f12da61956eb2306b69f9469b42f4deb0f3cb6ed47b9cce9996ced3"
+ "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08",
+ "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"
],
- "markers": "python_version >= '3.7'",
- "version": "==0.11.2"
+ "markers": "python_version >= '3.8'",
+ "version": "==0.12.1"
},
"platformdirs": {
"hashes": [
- "sha256:cf8ee52a3afdb965072dcc652433e0c7e3e40cf5ea1477cd4b3b1d2eb75495b3",
- "sha256:e9d171d00af68be50e9202731309c4e658fd8bc76f55c11c7dd760d023bda68e"
+ "sha256:11c8f37bcca40db96d8144522d925583bdb7a31f7b0e37e3ed4318400a8e2380",
+ "sha256:906d548203468492d432bcb294d4bc2fff751bf84971fbb2c10918cc206ee420"
],
- "markers": "python_version >= '3.7'",
- "version": "==3.11.0"
+ "markers": "python_version >= '3.8'",
+ "version": "==4.1.0"
},
"pre-commit": {
"hashes": [
- "sha256:5804465c675b659b0862f07907f96295d490822a450c4c40e747d0b1c6ebcb32",
- "sha256:841dc9aef25daba9a0238cd27984041fa0467b4199fc4852e27950664919f660"
+ "sha256:c255039ef399049a5544b6ce13d135caba8f2c28c3b4033277a788f434308376",
+ "sha256:d30bad9abf165f7785c15a21a1f46da7d0677cb00ee7ff4c579fd38922efe15d"
],
"index": "pypi",
- "version": "==3.5.0"
+ "markers": "python_version >= '3.9'",
+ "version": "==3.6.0"
},
"pylint": {
"hashes": [
- "sha256:0d4c286ef6d2f66c8bfb527a7f8a629009e42c99707dec821a03e1b51a4c1496",
- "sha256:60ed5f3a9ff8b61839ff0348b3624ceeb9e6c2a92c514d81c9cc273da3b6bcda"
+ "sha256:58c2398b0301e049609a8429789ec6edf3aabe9b6c5fec916acd18639c16de8b",
+ "sha256:7a1585285aefc5165db81083c3e06363a27448f6b467b3b0f30dbd0ac1f73810"
],
"index": "pypi",
- "version": "==3.0.2"
+ "markers": "python_full_version >= '3.8.0'",
+ "version": "==3.0.3"
},
"pyyaml": {
"hashes": [
@@ -577,27 +582,27 @@
},
"setuptools": {
"hashes": [
- "sha256:4ac1475276d2f1c48684874089fefcd83bd7162ddaafb81fac866ba0db282a87",
- "sha256:b454a35605876da60632df1a60f736524eb73cc47bbc9f3f1ef1b644de74fd2a"
+ "sha256:1e8fdff6797d3865f37397be788a4e3cba233608e9b509382a2777d25ebde7f2",
+ "sha256:735896e78a4742605974de002ac60562d286fa8051a7e2299445e8e8fbb01aa6"
],
"markers": "python_version >= '3.8'",
- "version": "==68.2.2"
+ "version": "==69.0.2"
},
"tomlkit": {
"hashes": [
- "sha256:df32fab589a81f0d7dc525a4267b6d7a64ee99619cbd1eeb0fae32c1dd426977",
- "sha256:eeea7ac7563faeab0a1ed8fe12c2e5a51c61f933f2502f7e9db0241a65163ad0"
+ "sha256:75baf5012d06501f07bee5bf8e801b9f343e7aac5a92581f20f80ce632e6b5a4",
+ "sha256:b0a645a9156dc7cb5d3a1f0d4bab66db287fcb8e0430bdd4664a095ea16414ba"
],
"markers": "python_version >= '3.7'",
- "version": "==0.12.2"
+ "version": "==0.12.3"
},
"virtualenv": {
"hashes": [
- "sha256:02ece4f56fbf939dbbc33c0715159951d6bf14aaf5457b092e4548e1382455af",
- "sha256:520d056652454c5098a00c0f073611ccbea4c79089331f60bf9d7ba247bb7381"
+ "sha256:4238949c5ffe6876362d9c0180fc6c3a824a7b12b80604eeb8085f2ed7460de3",
+ "sha256:bf51c0d9c7dd63ea8e44086fa1e4fb1093a31e963b86959257378aef020e1f1b"
],
"markers": "python_version >= '3.7'",
- "version": "==20.24.6"
+ "version": "==20.25.0"
}
}
}
diff --git a/README.md b/README.md
index cde336d..70b40e5 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,6 @@
Disco Hooker
-
[](https://github.com/psf/black)
[](https://pypi.org/project/leafengine/)
[](https://pycqa.github.io/isort/)
@@ -22,37 +21,50 @@ Thi is a simple Discord Hook notifier backend written in `flask` & `discord-webh
1. Docker image:
- a. Pull the image:
- ```sh
- docker pull droidzed/disco-hooker:latest
- ```
+ a. Pull the image:
+
+ ```sh
+ docker pull droidzed/disco-hooker:latest
+ ```
- b. Run the container:
- ```sh
- docker run -d -p 6000:6000 -e PORT=6000 -e WEBHOOK_URL=YOUR_DISCORD_WEBHOOK_URL droidzed/disco-hooker:latest
- ```
+ b. Run the container:
+
+ ```sh
+ docker run -d -p 6000:6000 -e PORT=6000 -e WEBHOOK_URL=YOUR_DISCORD_WEBHOOK_URL droidzed/disco-hooker:latest
+ ```
2. Run locally:
- a. Clone the repo:
- ```sh
- git clone https://github.com/DroidZed/disco-hooker.git
- ```
+ a. Clone the repo:
+
+ ```sh
+ git clone https://github.com/DroidZed/disco-hooker.git
+ ```
- b. Install deps:
+ b. Install deps:
- ```sh
- pipenv install
- ```
+ ```sh
+ pipenv install
+ ```
- c. Run:
- ```sh
- py app.py
- ```
+ c. Create `.env` file like so:
+
Make sure to fill in the required variables !
+
+ 
+
+ d. Run:
+
+ ```sh
+ py app.py
+ ```
3. API Request:
- 
+ 
+## Useful links:
+
+[Discord Webhooks](https://support.discord.com/hc/en-us/articles/228383668-Intro-to-Webhooks)
+
[Discord Webhooks & Safety](https://discord.com/safety/using-webhooks-and-embeds)
diff --git a/images/env.png b/images/env.png
new file mode 100644
index 0000000..08236aa
Binary files /dev/null and b/images/env.png differ