Metadata-Version: 2.1
Name: twittertail
Version: 0.6
Summary: Tail a twitter account from the command line.
Home-page: https://github.com/ndavison/twittertail
Author: Nathan Davison
Author-email: ndavison85@gmail.com
License: MIT
Download-URL: https://github.com/ndavison/twittertail/archive/v06.tar.gz
Description: # twittertail
        
        This python app monitors a Twitter account for tweet activity, using the asyncio library to create an event loop for the life of the running app. On execution, the 5 most recent tweets are displayed (like `tail`, so oldest to newest), and every 10 minutes new tweet activity is displayed. The app also includes an inbuilt HTTP API to retrieve all displayed tweets so far.
        
        ## setup
        
        This demo requires Python 3 (tested on Python 3.7.5+). To install:
        
        ```
        pip install twittertail
        ```
        
        ## cli
        
        The cli program can be run like so:
        
        ```
        twittertail -u TWITTER_USERNAME
        ```
        
        See `-h` for more options.
        
        [![asciicast](https://asciinema.org/a/UjCBfdewy87qeGSvejNlPnPeX.png)](https://asciinema.org/a/UjCBfdewy87qeGSvejNlPnPeX)
        
        ## HTTP
        
        By passing in a `-w` argument, a simple HTTP server will run, allowing you to query the tweets collected so far, which is returned in a `application/json` response as a JSON object.
        
        ```
        twittertail -u TWITTER_USERNAME -w
        ```
        
        Get tweets via:
        
        ```
        curl http://127.0.0.1:9000/tweets
        ```
        
        ## Run as a Docker container
        
        To run this as a Docker container, first build the image from the app's root directory:
        
        ```
        sudo docker build -t twittertail .
        ```
        
        And then run the container, passing in the Twitter username you want to monitor as the first argument:
        
        ```
        sudo docker run --rm -p 9000:9000 twittertail tinycarebot
        ```
        
        This also runs the HTTP server on port 9000.
Keywords: twitter,tweets,cli
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
