https://github.com/textbook/eleanor-rigbot
Eleanor Rigbot, searching for tweets that will fit in the scheme of this rhyme. What will it find?
https://github.com/textbook/eleanor-rigbot
Last synced: about 1 month ago
JSON representation
Eleanor Rigbot, searching for tweets that will fit in the scheme of this rhyme. What will it find?
- Host: GitHub
- URL: https://github.com/textbook/eleanor-rigbot
- Owner: textbook
- License: isc
- Created: 2017-03-28T14:49:55.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2022-12-08T10:54:11.000Z (over 3 years ago)
- Last Synced: 2025-01-08T07:52:45.325Z (over 1 year ago)
- Language: Python
- Homepage: https://twitter.com/eleanorrigbot
- Size: 42 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
Eleanor Rigby Robot
===================
.. contents:: The code powering `@eleanorrigbot`_.
What is this?
-------------
See the `tracking issue`_ in my About repository.
Eleanor Rigbot, searching for tweets
That will fit in the scheme of this rhyme
What will it find?
Running the bot
---------------
You can install and launch the application using::
python setup.py install
python launch_rigbot.py
or ``cf push`` it to `Cloud Foundry`_ using the ``manifest.yml`` file.
The following environment variables must be set to authenticate with the Twitter
API (e.g. using ``cf set-env ``):
- ``TWITTER_API_KEY``
- ``TWITTER_API_SECRET``
- ``TWITTER_ACCESS_TOKEN``
- ``TWITTER_ACCESS_TOKEN_SECRET``
See `the Tweepy Authentication tutorial`_ for more information.
For additional configuration, you can pass arguments to the launch script::
usage: launch_rigbot.py [-h] [--verbose]
[--location SW_LON SW_LAT NE_LON NE_LAT] [--version]
optional arguments:
-h, --help show this help message and exit
--verbose, -v set the logging level to DEBUG for more output
--location SW_LON SW_LAT NE_LON NE_LAT, -l SW_LON SW_LAT NE_LON NE_LAT
specify a location to filter (defaults to Liverpool)
--version show program's version number and exit
Development
-----------
To install for development, install the package and all of its requirements
with::
pip install -r requirements.txt
python setup.py develop
You can run the tests with::
python setup.py test
Matching other phrases
----------------------
If you would like to match a different phrase, you can use the ``PhraseMatcher``
to create an alternate matcher. For example:
.. code-block:: python
# https://www.flickr.com/places/info/12591829
napoli = [13.8509, 40.5360, 14.6697, 41.0201]
# "when the moon hits your eye like a big pizza pie"
that_is_amore = PhraseMatcher((3, 3, 3, 3), (None, 'a', None, 'a'))
start_listening(napoli, that_is_amore)
.. _@eleanorrigbot: https://twitter.com/eleanorrigbot
.. _Cloud Foundry: https://www.cloudfoundry.org/
.. _the Tweepy Authentication tutorial: http://tweepy.readthedocs.io/en/v3.5.0/auth_tutorial.html
.. _tracking issue: https://github.com/textbook/about/issues/12