[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/zekro/itsfriday/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","zekro","reponame","itsfriday","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2019-07-09T11:20:33.755209Z","description","The tool for spreading friday-happiness to your Twitter followers! ","is_private","last_updated","2021-07-06T06:23:22.258286Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",281,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","

~ It's Friday! ~

\n \n The tool for spreading friday-happiness to your Twitter followers!\n

\n

\n
\n

\n\n---\n\n# Why?\n\nImagine waking up, looking on your phone and noticing: It's finally friday! You are going to work, full of aniticipation to the end of the workday - chilling with some beer or with your friends on a tasty barbeque...\n\nAnd this tool provides an easy way to spread some of your friday-happiness to your twitter followers! Just enter a collection of carefully picked, happy friday images into the config, create an [API app](https://developer.twitter.com/en/apps), enter your apps credentials and everything is ready to go.\n\nThen, you can define a time when a randomly picked image out of the defined pool of files and URLs will be directly brought onto your followers timeline.\n\n---\n\n# Contribute Images\n\nJust [fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) this repository and add your desired image to the `data/pool` directory. After that, just create a [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request) with your changes. It's that easy! 😉\n\n# Setup\n\n## Requirements\n\n- Python **(> v.3.6)**\n- git\n- GNU make *(optional)*\n\nFirst of all, you need to [**create a Twitter API application**](https://developer.twitter.com/en/apps/create) to connect the tool to your account.\n\nThen, clone this repository to your system and cd into the directory:\n\n```\n$ git clone https://github.com/zekroTJA/itsfriday --branch master --depth 1\n$ cd itsfriday\n```\n\nThen, install the required dependencies:\n```\n$ python3 -m pip install -U --user -r requirements.txt\n```\nor simply use the make file for that:\n```\n$ make deps\n```\n*Maybe, you need to configure the Makefile before to use the right python command.*\n\nAfter that was successful, run the main.py to generate a config file:\n```\n$ python3 ./main.py -c myConfig.json\n```\n\n## Docker\n\nAlternatively, you can use the automatically pre-build Docker images available on [Docker Hub](https://hub.docker.com/r/zekro/itsfriday).\n\n```\n$ docker pull zekro/itsfriday:latest\n```\n\nThen, start up the image. You should bind the data location `/etc/data` and set this in your config file to create a gateway if you want to use local files on your host system to be posted on twitter.\n```\n$ docker run \\\n -v \"/etc/itsfriday/config:/etc/config\" \\\n -v \"/etc/itsfriday/data:/etc/data\"\n```\n\nOr when using docker-compose:\n```yaml\nversion: '3'\n\nservices:\n # ...\n \n itsfriday:\n image: 'zekro/itsfriday:latest'\n volumes:\n - '/etc/itsfriday/config:/etc/config'\n - '/etc/itsfriday/data:/etc/data'\n restart: always\n```\n\n## Config\n\nThen, open the config and enter your Twitter API app credentials, the time when the event should fire every friday, a message text *(can be empty)*, and some local file directions *(directly to a file or to a folder containing image files)* or URLs to online images which should be used as pool for the randomly picked images to post.\n```json\n{\n \"time\": \"9:00:00\",\n \"message\": \"Yay, it's friday!\",\n \"twitter\": {\n \"consumer_key\": \"s0m33x4mpl3c0n5um3rk3y\",\n \"consumer_secret\": \"4n0th3r3x4mpl3c0n5um3r53cr3t\",\n \"access_token_key\": \"th15154n3x4mpl3t0k3nk3y\",\n \"access_token_secret\": \"4ndth1s1s4l50ju5t4n3x4mpl3t0k3n53cr3t\"\n },\n \"image_files\": [\n \"https://example.com/myimagefile.png\",\n \"/home/you/icon.png\",\n \"/home/you/img\"\n ]\n}\n```\n\nThen, fire the handler once just for testing:\n```\n$ python3 ./main.py -c myConfig.json --once\n```\n\nNow, you can set up for automated tweet posting:\n\nTherefore are two options to do so:\n\n### I) Running as deamon\n\nFor this, you should use something like [`pm2`](https://github.com/Unitech/pm2) or [`screen`](https://www.rackaid.com/blog/linux-screen-tutorial-and-how-to). \nIn this example, I will use pm2:\n\nFor that, create a start script which can be used as single executable to start the script:\n> start.sh\n```bash\n#!/bin/bash\nREPO=\"/path/to/itsfriday\"\npython3 ${REPO}/main.py -c ${REPO}/myConfig.json\n```\n\nDont forget to make the script executable after!\n```\n$ chmod +x ./start.sh\n```\n\nNow, initialize the pm2 deamon:\n```\n$ pm2 start --name itsfriday ./start.sh\n```\n\nAfter that, assure that the deamon is running with\n```\n$ pm2 ls\n```\n\nNow, a timer is running frequently checking for the time and executing the twitter push if the trigegr time has been hit. \nIf the script crashes for some reason, pm2 will restart and keep it alive *(except the script is crashing frequently directly after start to avoid an endless start loop)*.\n\n### II) Using cron *(or something similar)*\n\nFor this example, I am using cron:\n\n```\n$ crontab -e\n```\n\nNow, create an entry to fire your post, for example, every friday at 9 AM:\n```\n0 9 * * 5 python3 /path/to/itsfriday/main.py -c /path/to/itsfriday/config.json --once\n```\n\nIt is very important to set the flag **`--once`**, which will not start the timer loop and only fire the event once.\n\n---\n\n© 2019 Ringo Hoffmann (zekro Development) \nCovered by MIT Licence.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",1149974476,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",3873381,"full_size",363793503,"id",61560050,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:52ecddff075ee63bb5b636deaaed74095dde1b6e6e9e48b1525a940985829f25","features","","last_pulled","2026-10-01T01:49:36.456022749Z","last_pushed","2021-07-06T06:23:22Z","os","linux","os_features","os_version","size","variant","2021-07-06T06:23:21.846486Z","last_updater","last_updater_username","media_type","latest","repository",7378674,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

zekro/itsfriday

Tags for zekro/itsfriday