From 203c6281ade2e9036d77ef61ede131ae6306c388 Mon Sep 17 00:00:00 2001 From: offical-Cromatin Date: Sun, 6 Oct 2024 17:38:28 +0200 Subject: [PATCH] Initial set-up and establishment of a structure for the project --- .gitignore | 3 +++ LICENSE | 21 +++++++++++++++++++++ README.md | 25 +++++++++++++++++++++++++ requirements.txt | 0 src/main.py | 0 5 files changed, 49 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100644 requirements.txt create mode 100644 src/main.py diff --git a/.gitignore b/.gitignore index 82f9275..72bc3e2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,6 @@ +# Custom additions +logs/ + # Byte-compiled / optimized / DLL files __pycache__/ *.py[cod] diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f0ce113 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Lars Winzer + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..0faa76f --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# POST-IT! + +## Overview + +The **Cross-Platform Post Embedder Bot** is a Discord bot designed to unify and simplify the process of sharing media from multiple platforms such as Reddit, Twitter, Tumblr, Mastodon, and more + +## Planned Platforms + +- Reddit +- X (f.k.a. Twitter) +- Tumblr +- Mastodon +- Other social media platforms to be added in future releases + +## How It Works + +1. **Post Link Submission:** Users provide a link to a post from a supported platform. +2. **Embed Generation:** The bot fetches the content of the post (e.g. images, text) and generates a standardized Discord embed. +3. **Customization:** Depending on user or server settings, the format of the embed can vary, allowing for a personalized experience. + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details. + +Feel free to adjust or add any specific details related to the functionality of your bot or any additional features as they are implemented! \ No newline at end of file diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/src/main.py b/src/main.py new file mode 100644 index 0000000..e69de29