https://github.com/pixelbrackets/has_yet

Has … yet? Script to set up a Twitter bot tweeting answers to important questions like “Has something happend yet?”
https://github.com/pixelbrackets/has_yet

bot cron php twitter twitter-bot

Last synced: 3 days ago
JSON representation

Has … yet? Script to set up a Twitter bot tweeting answers to important questions like “Has something happend yet?”

• Host: GitHub
• URL: https://github.com/pixelbrackets/has_yet
• Owner: pixelbrackets
• Created: 2014-12-10T21:03:32.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2019-08-05T08:26:36.000Z (over 5 years ago)
• Last Synced: 2024-10-11T18:18:04.320Z (27 days ago)
• Topics: bot, cron, php, twitter, twitter-bot
• Language: PHP
• Homepage: https://gitlab.com/pixelbrackets/has_yet/
• Size: 47.9 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
Has … yet?

==========

[![Packagist](https://img.shields.io/packagist/v/pixelbrackets/has_yet.svg)](https://packagist.org/packages/pixelbrackets/has_yet/)

[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/has___yet)

Has something happend yet? This is a small script to set up one of those 

Twitter bot accounts which automatically tweet answers to important questions like:

* Has invisibility been invented yet?

* Has [sports team] won/lose yet?

* Has [shady polititian] resigned yet?

* Has the world ended yet?

Example twitter bot using this repository:

* https://twitter.com/has___yet

## Requirements

* Twitter API Key

* PHP

* Composer

* Cronjob

## Usage

The PHP script should be executed with a cronjob. It then reads a JSON file

consisting of default messages and messages for special dates. One message is

selected and then pushed to a given Twitter account.

It is possible set up multiple accounts.

## Installation

**Set up the script**

1. Use composer to install the script and all dependencies

    * `composer create-project pixelbrackets/has_yet`

1. Copy the [configuration example file](./configuration.json.example) and 

   rename it to `configuration.json`

    * The example configuration should be self-explaining, you may define 

      custom messages for special days and/or one or more default messages

    * A status message may consist of a text and an image

    * The optional image may be a local filename or a URL (http/https supported)

1. Protect the whole folder from public access (eg. with a [htaccess file](./.htaccess.example) 

   or move the directory outside of the document root)!

**Set up a Twitter account**

1. Register a Twitter account (that was obvious, wasn't it?)

1. Register an app for this account

    * The advantage of this move is that you won't need to set up an OAuth Login, 

      since Twitter offers to generate an Access Token for the own account

1. Go to https://apps.twitter.com/ to create/register the Twitter App

1. Click “Create New App” Button

1. Create an application (Name, Description, Website etc.)

1. Change “Permissions” to “Read & Write”

1. Generate an Access Token on the “Keys and Access Tokens” tab

1. Copy API Key, API Secret, Access Token, Access Token Secret into the 

   configuration file

**Set up a cronjob**

1. Set up a cronjob which points to the `cron.php` file

    * eg. `0 10 * * * php /path/to/cron.php`

    * You may choose any interval, but be aware that Twitter has a mechanism to 

      detect duplicate tweets (https://twittercommunity.com/t/duplicate-tweets/13264). 

      Consider this if you want to frequently post the same status message. 

      It appears that a 24 hour time range is sufficient.

1. If you want to set up multiple accounts or use varying messages, then rename 

   the JSON configuration file and pass the filename as argument

   * eg. `johndoe.json` and `php /path/to/cron.php johndoe`

## Source

https://github.com/pixelbrackets/has_yet/

## Documentation

Read online (HTML) https://github.com/pixelbrackets/has_yet/blob/master/README.md

## License

GNU General Public License version 2 or later

The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.

## Author

Dan Untenzu ( / [@pixelbrackets](https://github.com/pixelbrackets))

## Changelog

See [./CHANGELOG.md](CHANGELOG.md)

## Contribution

This script is Open Source, so please use, patch, extend or fork it.