Twitter to dust

Twitter to dust retrieves the last 200 tweets of the user account and removes those older than a given expiration time (in days). If a keyword is defined, it will keep the tweets that include that keyword in the text of the tweet.

Prerequisites

• Node.js
• NPM (usually comes with Node.js).

Installing

# clone the repository
git clone https://github.com/agm-dev/twitter-to-dust.git

# go into the directory and install the required packages
cd twitter-to-dust
npm install

# copy the .env.example and fill up the variables
cp .env.example .env

Environment variables

Name	Description
TWITTER_USERNAME	The Twitter username of the account
TWITTER_API_KEY	The API key from Twitter's dev portal
TWITTER_API_SECRET	The API secret from Twitter's dev portal
TWITTER_ACCESS_TOKEN	The access token from Twitter's dev portal
TWITTER_ACCESS_TOKEN_SECRET	The access token secret from Twitter's dev portal
DAYS_TO_DUST	The expiration time in days
DONT_DELETE_KEYWORD	The string (case sensitive) that avoids removing the tweet if it's included in the text of the tweet.

Tests

# exec this command to run the unit tests
npm run test

# this other one to check the coverage
npm run test:coverage

Deployment

You can schedule this script to be run n times a day using crontab for instance.

The following example would run the script each 2 hours (at minute 0) and log the results of executions on output.log.

# 'crontab -e' on linux systems to add the following line
0 */2 * * * /usr/bin/node /absolute/path/to/the/script/index.js >> /absolute/path/to/the/script/output.log 2>&1

Contributing

Just submit your pull request :)

Versioning

This uses semantic versioning.

License

This software is licensed under the MIT license.