Metadata-Version: 2.1
Name: Karlsruher
Version: 2.1b7
Summary: Karlsruher Twitter Robot
Home-page: https://github.com/schlind/Karlsruher
Author: Karlsruher Twitter Robot Society
Author-email: karlsruher-dev@schlind.org
Maintainer: Sascha Schlindwein
Maintainer-email: karlsruher-dev@schlind.org
License: UNKNOWN
Project-URL: Source, https://github.com/schlind/Karlsruher/
Description: # @Karlsruher
        * is a robot on Twitter ([Link](https://twitter.com/Karlsruher))
        * retweets mentions from its followers when they apply some rules
        ---
        
        ## Setup instructions
        
        #### Prerequisites:
        * Python 3 environment (tested with 3.5 on Linux, 3.8.5 MacOS)
        * The Robot needs a home directory for its work
        * You need [Twitter API credentials](https://developer.twitter.com) for your Robot
        
        #### Install the latest release into your Python 3 library:
        ```bash
        $ python3 -m pip install -U --user --pre karlsruher
        ```
        *Still in Beta mode: --pre and expect a moving target!*
        
        #### Create a home directory
        You might want to use a different path here:
        ```bash
        export ROBOT_HOME=$HOME/karlsruher
        mkdir -p $ROBOT_HOME
        ```
        #### Create auth.yaml credentials file
        You want to enter your own credentials here:
        ```bash
        export ROBOT_HOME=$HOME/karlsruher
        cat >$ROBOT_HOME/auth.yaml <<EOF
        # You must enter real credentials here:
        twitter:
          consumer:
            key: 'YOUR-CONSUMER-KEY'
            secret: 'YOUR-CONSUMER-SECRET'
          access:"
            key: 'YOUR-ACCESS-KEY'
            secret: 'YOUR-ACCESS-SECRET'
        EOF
        ```
        
        #### Setup complete
        
        ## First run
        #### The Robot needs to fetch its followers and friends from Twitter regularly, run this initially and once per day:
        ```bash
        export ROBOT_HOME=$HOME/karlsruher
        karlsruher --home=$ROBOT_HOME -housekeeping
        ```
        
        #### To just perfom the desired retweet feature, run this at any interval:
        ```bash
        export ROBOT_HOME=$HOME/karlsruher
        karlsruher --home=$ROBOT_HOME
        ```
        
Keywords: twitter robot bot retweet cronjob
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: License :: Public Domain
Classifier: Topic :: Artistic Software
Classifier: Topic :: Internet
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Unix
Requires-Python: >=3.4, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
