twaffle

    0.0.2 • Public • Published

    Twaffle

     _                  __  __ _
    | |                / _|/ _| |
    | |___      ____ _| |_| |_| | ___
    | __\ \ /\ / / _' |  _|  _| |/ _ \
    | |_ \ V  V / (_| | | | | | |  __/
     \__| \_/\_/ \__,_|_| |_| |_|\___|
    

    A TWitter rAFFLE script.

    CircleCI npm version

    Twaffle allows you to extract random tweets for a set of keywords. It's ideal to do raffles over tweeter: get some people to tweet some specific keywords and then extract an arbitrary number of random winners!

    Install

    npm install --global twaffle

    Or you can use it with npx (see usage), so in such case you don't have to install it at all.

    Finally, you can also use the compiled binaries distributed for the major operative systems.

    Usage

    To use Twaffle you would need to access to the Twitter developer platform and have obtained keys for an app.

    Once you got your keys, make sure that they are exported as environment variables in the local shell:

    export TWITTER_CONSUMER_KEY="..."
    export TWITTER_CONSUMER_SECRET="..."
    export TWITTER_ACCESS_TOKEN_KEY="..."
    export TWITTER_ACCESS_TOKEN_SECRET="..."

    Note: Twitter keys can also be passed as arguments, see twaffle --help for more details.

    At this point you can run twaffle as in the following example:

    twaffle --keywords '#oredev again' --winners=3

    this will extract 3 random tweets that have the keywords #oredev and again.

    If you didn't install twaffle and you have a recent version of NPM you can simply run twaffle through npx:

    npx twaffle --keywords '#oredev again' --winners=3

    Bugs and improvements

    If you find a bug or have an idea about how to improve Twaffle you can open an issue or submit a pull request, it will definitely make you a better person! 😇

    License

    Licensed under MIT License. © Luciano Mammino.

    Keywords

    none

    Install

    npm i twaffle

    DownloadsWeekly Downloads

    0

    Version

    0.0.2

    License

    ISC

    Unpacked Size

    11.9 kB

    Total Files

    9

    Last publish

    Collaborators

    • lmammino