Skip to content

Latest commit

 

History

History
113 lines (90 loc) · 5.21 KB

README.md

File metadata and controls

113 lines (90 loc) · 5.21 KB

sauce_man

  • sauce_man is a discord bot to make discord app bertter to:
    • advanced search features for who want make some records or fix the broken preview from some outside URLs.
    • Fix Links Previews.

To-do-list

working

  • update Dockerfile
  • migrage from pyenv+poetry to uv
  • test discord.py
  • find a better and safe way to set env
  • implement event handling
    • Discord Twitter Link Handler ✅ Detect Twitter links in messages ✅ Extract Tweet ID from the URL ✅ Fetch tweet data using fxtwitter API (fallback to vxtwitter API) ✅ Generate a Discord Embed containing tweet details ✅ Send tweet media (images/videos) separately ✅ Provide a backup link if API calls fail ✅ Suppress Discord’s default Twitter preview
  • implement channel app commands
    • search history messages from a specific channel
    • dump history messages from a specific channel
      • calculate the range <= 100 for iterator to append all history to the stored list

pending

done

  • separate function load_config from class or not? (Hint: Like django settings.py)
  • postgresql db init

quick-start

#setting up 
bash scripts/uv_tools.sh

#build docker container image
docker build . -t docker.io/focal1119/sauce_man:test

#run container with docker run
docker run -d --env-file=.env --name sauce_man docker.io/focal1119/sauce_man:test

#run with docker compose
#up and run in background
docker compose up -d

#down
docker compose down

#podman container build/run
podman build . -t docker.io/focal1119/sauce_man:test
podman build . --no-cache -t docker.io/focal1119/sauce_man:test
podman run -d --env-file=.env --name sauce_man docker.io/focal1119/sauce_man:test

misc

Important!!!

== We're Using GitHub Under Protest ==

This project is currently hosted on GitHub. This is not ideal; GitHub is a proprietary, trade-secret system that is not Free and Open Souce Software (FOSS). We are deeply concerned about using a proprietary system like GitHub to develop our FOSS project. We have an open {bug ticket, mailing list thread, etc.} where the project contributors are actively discussing how we can move away from GitHub in the long term. We urge you to read about the Give up GitHub campaign from the Software Freedom Conservancy to understand some of the reasons why GitHub is not a good place to host FOSS projects.

If you are a contributor who personally has already quit using GitHub, please check this resource for how to send us contributions without using GitHub directly.

Any use of this project's code by GitHub Copilot, past or present, is done without our permission. We do not consent to GitHub's use of this project's code in Copilot.

Logo of the GiveUpGitHub campaign