Gazouilleur is an IRC bot offering Twitter interactions on multiple channels in order to:
Inspired by La Quadrature du Net's IRC bot UnGarage developped by Bram, Gazouilleur was developped for the daily organisational and collaborative needs of Regards Citoyens.
See the list of all available IRC commands in LIST_COMMANDS.md
For an easy install either on Linux, Mac OS X or Windows, the best solution is to rely on Docker.
First, you should deploy Docker on your machine following its official installation instructions.
Once you've got Docker installed and running, you will need Docker Compose to set up and orchestrate Hyphe services in a single line. Docker Compose is already installed along with Docker on Windows and Mac OS X, but you may need to install it for Linux.
Collect Gazouilleur's sourcecode from this git repository, then enter the resulting directory:
git clone https://github.com/RouxRC/gazouilleur.git gazouilleur
cd gazouilleurThen, copy the default configuration files and edit them to adjust the settings to your needs:
# use "copy" instead of "cp" under Windows powershell
cp docker-config.env.example docker-config.envThen edit docker-config.env file to configure the bot following gazouilleur/config.py.example's explanations. Do not put quotes around variables values and use only one line per variable, even for json formatted ones.
You have two options: either collect, or build Gazouilleur's Docker container.
Recommended: Pull our official preassembled images from the Docker Store
docker-compose pullAlternative: Build your own images from the source code (mostly for development or if you intend to edit the code, and for some very specific configuration settings):
docker-compose buildPulling should be faster, but it will still take a few minutes to download or build everything either way.
Finally, start Gazouilleur with the following command, which will run it and display all of its logs in the console until stopped by pressing Ctrl+C.
docker-compose upOr run the containers as a background daemon (for instance for production on a server):
docker-compose up -dFirst download the repository:
git clone https://github.com/RouxRC/gazouilleur.git
cd gazouilleurFor an easy install on Debian and CentOS like distributions, you can try running bash bin/install.sh or follow step by step the installation script readable here.
After dependencies are installed, you will need to edit your configuration in gazouilleur/config.py, then run bash bin/configureDB.sh to prepare your Mongo database.
Depending on the desired options, the configuration will require to get Twitter and/or Identi.ca API rights (see below).
You can also scroll down to the detailed installation instructions below.
Note: There currently is no packaged version of Gazouilleur, but you can set it up as a system service thanks to Lunar^ by:
gazouilleur.service into /etc/systemd/system/gazouilleur.serviceStart, stop or restart the bot: Just run the starter script with either argument start, stop or restart. Add --nologs option do disable log display after start.
bin/gazouilleur <start|stop|restart> [--nologs]Follow logs:
tail -fn 50 log/run.logAutostart bot on machine reboot via crontab:
Add the following line via crontab -e where $GAZOUILLEUR_PATH is Gazouilleur's install path:
@reboot $GAZOUILLEUR_PATH/bin/gazouilleur start --quietIf you're running this bot after Jan 1th, 2020, you will need to use PyEnv to manage a Python2.7 environnement. To do that, the instructions are as follows ;
Please follow the instructions here : https://pyenv.run/
Type the following commands in your terminal ;
export PYENV_VIRTUALENV_DISABLE_PROMPT=1
eval "$(pyenv init --path)"
source $(which virtualenvwrapper.sh) || ( echo "Error: You must install virtualenvwrapper to use this starter: sudo pip -q install virtualenvwrapper" && exit 1 )
export PATH="$PYENV_ROOT/bin:$PATH"
eval "$(pyenv init -)"
eval "$(pyenv virtualenv-init -)"
export PYENV_ROOT="$HOME/.pyenv"
Theses commands indicate to PyEnv how to setup the virtual environnement.
Type the following commands in your terminal ;
pyenv install 2.7.18
pyenv virtualenv 2.7.18 gazouilleur
pip install -r requirements.txt
_NB : You might run into an issue while installing Twisted. You can install it directly from git like this pip install https://github.com/twisted/twisted/archive/refs/tags/twisted-15.1.0.zip. Run the command above again if needed. Also check your Python and Pip versions.
cd gazouilleur
pwd > ~/.pyenv/versions/gazouilleur/lib/python2.7/site-packages/gazouilleur.path
You should be able to launch Gazouilleur with the bin/gazouilleur start command, but in case it does no work, you can try with : twistd --pidfile gazouilleur.pid -y gazouilleur/bot.py.
Good luck !
In order to send tweets from IRC, each channel needs to be associated with a distinct Twitter account and its API tokens with "Read, Write, and Direct Messages" rights.
"Read only" rights can be sufficient if and only if "FORBID_POST" option is set for the channel : this case allows one to use Twitter's streaming and search API for monitoring keywords or accounts without wanting to send tweets.
Such monitoring is also permitted, with less accuracy, for configs without any Twitter account, by parsing IceRocket.com or Topy.com's HTML search results, but the accuracy and completeness is seriously impacted.
Create or recover an Identi.ca account on the new Pump.io service.
Set your Identi.ca USER name in gazouilleur/config.py
Run the following commands and be guided:
source /usr/local/bin/virtualenvwrapper.sh
workon gazouilleur
python bin/auth_identica.py
deactivate(These instuctions are meant for GNU/Linux Debian/Ubuntu-like and CentOS-like distributions. Experiences on other distribs welcome!)
The following Debian-like packages, quite common, are necessary:
sudo apt-get install curl git vim python-dev python-pip libxml2-dev libfreetype6-dev libpng-dev libxslt1-dev libffi-devOn CentOS:
sudo yum install curl git vim python-devel python-setuptools python-pip easy_install libxml2 libxml2-dev libfreetype6-dev libpng-dev libxslt libxslt-devel gcc libffi-devel openssl-devel
sudo easy_install pip git clone https://github.com/RouxRC/gazouilleur.git
cd gazouilleurNote: MongoDB being limited to 2Go databases on 32bit systems, it is recommanded to install Gazouilleur on a 64bit machine for extreme use of the Twitter keyword tracking functionnality.
Note2: MongoDB Version 2.2 at least is required to get the aggregate functions to work properly. Everything will work with older versions except for the "!tweetswith" command.
Edit your apt sources.list file to include the following line:
deb http://downloads-distro.mongodb.org/repo/ubuntu-upstart dist 10genInstall the GPG key for this repository, update apt lists and install MongoDB:
curl -s http://docs.mongodb.org/10gen-gpg-key.asc | sudo apt-key add -
sudo apt-get update
sudo apt-get install mongodb-10gen
sudo service mongodb restartYou can configure the MongoDB server by editing /etc/mongodb.conf.
echo "[mongodb]
name=MongoDB Repository
baseurl=http://downloads-distro.mongodb.org/repo/redhat/os/x86_64/
gpgcheck=0
enabled=1" > mongodb.repo.tmp
sudo mv mongodb.repo.tmp /etc/yum.repos.d/mongodb.repo
# Then update yum's source list and install:
sudo yum check-update
sudo yum install mongo-10gen mongo-10gen-server
sudo chkconfig mongod on
sudo service mongod restartAdmin use: RockMongo is a nice PhpMyAdmin-like web tool to examine a MongoDB.
It's recommended to use virtualenv with virtualenvwrapper:
sudo pip install virtualenv
sudo pip install virtualenvwrapperCreate a virtualenv for the bot from within this directory and install dependencies:
source $(which virtualenvwrapper.sh)
mkvirtualenv --no-site-packages gazouilleur
workon gazouilleur
easy_install -U distribute
# Install NumPy if you want to activate the URL_STATS option
# pip install -q numpy
# Uncomment first NumPy related lines in requirements.txt to activate URL_STATS
pip install -r requirements.txt
add2virtualenv .
deactivatePrepare your configuration by generating template files by running:
bash bin/configure.shGet your Twitter and Identi.ca API keys if needed as explained above.
Choose a name for the bot and preferably register it on the desired IRC server. For instance on Freenode, do from an IRC client:
/nick <BOTNAME>
/msg NickServ REGISTER <BOTPASS> <EMAIL>
/msg NickServ VERIFY REGISTER <BOTNAME> <KEY_RECEIVED_ON_EMAIL>Set BOTNAME and BOTPASS in gazouilleur/config.py and complete the different parts of the global configuration and the specific channels settings.
Create the MongoDB database and its owner both having the same name as the bot by running:
bash bin/configureDB.shRun Gazouilleur!
bin/gazouilleur startRun the following script:
bin/update.shThen check your configuration file against gazouilleur/config.py.example to add any new possible option.
To use an Identi.ca account since the Pump.io migration, the following commands must also be ran after setting IDENTICA's USER in gazouilleur/config.py:
source /usr/local/bin/virtualenvwrapper.sh
workon gazouilleur
python bin/auth_identica.py
deactivate