Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zekrotja/itsfriday

The tool for spreading friday-happiness to your Twitter followers!
https://github.com/zekrotja/itsfriday

bot hacktoberfest memes twitter

Last synced: about 1 month ago
JSON representation

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

Awesome Lists containing this project

README 

        


    

    
~ It's Friday! ~


    

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

    



     







---



# Why?



Imagine 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...



And 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.



Then, 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.



---



# Contribute Images



You can just create an issue with [**this template**](https://github.com/zekroTJA/itsfriday/issues/new?assignees=zekrotja&labels=contribute-image&template=extract-image.yml&title=Image+Contribution) and put in your image link there. After that, the image will be reviewed and then added to the repository, if accepted.



Otherwise, if you want to be part of the contributors list, just [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! 😉



# Setup



## Requirements



- Python **(> v.3.6)**

- git

- GNU make *(optional)*



First of all, you need to [**create a Twitter API application**](https://developer.twitter.com/en/apps/create) to connect the tool to your account.



Then, clone this repository to your system and cd into the directory:



```

$ git clone https://github.com/zekroTJA/itsfriday --branch master --depth 1

$ cd itsfriday

```



Then, install the required dependencies:

```

$ python3 -m pip install -U --user -r requirements.txt

```

or simply use the make file for that:

```

$ make deps

```

*Maybe, you need to configure the Makefile before to use the right python command.*



After that was successful, run the main.py to generate a config file:

```

$ python3 ./main.py -c myConfig.json

```



## Docker



Alternatively, you can use the automatically pre-build Docker images available on [Docker Hub](https://hub.docker.com/r/zekro/itsfriday).



```

$ docker pull zekro/itsfriday:latest

```



Then, 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.

```

$ docker run \

    -v "/etc/itsfriday/config:/etc/config" \

    -v "/etc/itsfriday/data:/etc/data"

```



Or when using docker-compose:

```yaml

version: '3'



services:

  # ...

  

  itsfriday:

    image: 'zekro/itsfriday:latest'

    volumes:

      - '/etc/itsfriday/config:/etc/config'

      - '/etc/itsfriday/data:/etc/data'

    restart: always

```



## Config



Then, 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.

```json

{

  "time": "9:00:00",

  "message": "Yay, it's friday!",

  "twitter": {

    "consumer_key": "s0m33x4mpl3c0n5um3rk3y",

    "consumer_secret": "4n0th3r3x4mpl3c0n5um3r53cr3t",

    "access_token_key": "th15154n3x4mpl3t0k3nk3y",

    "access_token_secret": "4ndth1s1s4l50ju5t4n3x4mpl3t0k3n53cr3t"

  },

  "image_files": [

    "https://example.com/myimagefile.png",

    "/home/you/icon.png",

    "/home/you/img"

  ]

}

```



Then, fire the handler once just for testing:

```

$ python3 ./main.py -c myConfig.json --once

```



Now, you can set up for automated tweet posting:



Therefore are two options to do so:



### I) Running as deamon



For 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).  

In this example, I will use pm2:



For that, create a start script which can be used as single executable to start the script:

> start.sh

```bash

#!/bin/bash

REPO="/path/to/itsfriday"

python3 ${REPO}/main.py -c ${REPO}/myConfig.json

```



Dont forget to make the script executable after!

```

$ chmod +x ./start.sh

```



Now, initialize the pm2 deamon:

```

$ pm2 start --name itsfriday ./start.sh

```



After that, assure that the deamon is running with

```

$ pm2 ls

```



Now, a timer is running frequently checking for the time and executing the twitter push if the trigegr time has been hit.  

If 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)*.



### II) Using cron *(or something similar)*



For this example, I am using cron:



```

$ crontab -e

```



Now, create an entry to fire your post, for example, every friday at 9 AM:

```

0 9 * * 5 python3 /path/to/itsfriday/main.py -c /path/to/itsfriday/config.json --once

```



It is very important to set the flag **`--once`**, which will not start the timer loop and only fire the event once.



---



© 2019 Ringo Hoffmann (zekro Development)  

Covered by MIT Licence.