{"id":15673716,"url":"https://github.com/lmammino/twaffle","last_synced_at":"2025-03-30T05:44:18.146Z","repository":{"id":138311346,"uuid":"158424569","full_name":"lmammino/twaffle","owner":"lmammino","description":"A TWitter rAFFLE script.","archived":false,"fork":false,"pushed_at":"2018-11-20T23:23:34.000Z","size":78,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-15T00:12:17.415Z","etag":null,"topics":["command-line","command-line-tool","javascript","raffle","raffler","script","twitter","twitter-api"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lmammino.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-11-20T17:07:16.000Z","updated_at":"2018-11-21T07:23:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"0e31ae38-9874-4774-870a-970825719c0b","html_url":"https://github.com/lmammino/twaffle","commit_stats":{"total_commits":4,"total_committers":1,"mean_commits":4.0,"dds":0.0,"last_synced_commit":"2fff0991912287459ef90590833735444bc32d77"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmammino%2Ftwaffle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmammino%2Ftwaffle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmammino%2Ftwaffle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lmammino%2Ftwaffle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lmammino","download_url":"https://codeload.github.com/lmammino/twaffle/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246281215,"owners_count":20752207,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","command-line-tool","javascript","raffle","raffler","script","twitter","twitter-api"],"created_at":"2024-10-03T15:41:50.525Z","updated_at":"2025-03-30T05:44:18.119Z","avatar_url":"https://github.com/lmammino.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Twaffle\n\n```\n _                  __  __ _\n| |                / _|/ _| |\n| |___      ____ _| |_| |_| | ___\n| __\\ \\ /\\ / / _' |  _|  _| |/ _ \\\n| |_ \\ V  V / (_| | | | | | |  __/\n \\__| \\_/\\_/ \\__,_|_| |_| |_|\\___|\n```\n\nA TWitter rAFFLE script.\n\n[![CircleCI](https://circleci.com/gh/lmammino/twaffle.svg?style=shield)](https://circleci.com/gh/lmammino/twaffle) [![npm version](https://badge.fury.io/js/twaffle.svg)](http://badge.fury.io/js/twaffle)\n\nTwaffle 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!\n\n## Install\n\n```bash\nnpm install --global twaffle\n```\n\nOr you can use it with `npx` (see [usage](#usage)), so in such case you don't have to install it at all.\n\nFinally, you can also use the [compiled binaries](https://github.com/lmammino/twaffle/releases) distributed for the major operative systems.\n\n## Usage\n\nTo use Twaffle you would need to access to the [Twitter developer platform](https://developer.twitter.com) and have obtained keys for an app.\n\nOnce you got your keys, make sure that they are exported as environment variables in the local shell:\n\n```bash\nexport TWITTER_CONSUMER_KEY=\"...\"\nexport TWITTER_CONSUMER_SECRET=\"...\"\nexport TWITTER_ACCESS_TOKEN_KEY=\"...\"\nexport TWITTER_ACCESS_TOKEN_SECRET=\"...\"\n```\n\n**Note**: Twitter keys can also be passed as arguments, see `twaffle --help` for more details.\n\nAt this point you can run twaffle as in the following example:\n\n```bash\ntwaffle --keywords '#oredev again' --winners=3\n```\n\nthis will extract `3` random tweets that have the keywords `#oredev` and `again`.\n\nIf you didn't install twaffle and you have a recent version of NPM you can simply run twaffle through `npx`:\n\n```bash\nnpx twaffle --keywords '#oredev again' --winners=3\n```\n\n## Bugs and improvements\n\nIf you find a bug or have an idea about how to improve Twaffle you can [open an issue](https://github.com/lmammino/twaffle/issues) or [submit a pull request](https://github.com/lmammino/twaffle/pulls), it will definitely make you a better person! 😇\n\n## License\n\nLicensed under [MIT License](LICENSE). © Luciano Mammino.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmammino%2Ftwaffle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flmammino%2Ftwaffle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flmammino%2Ftwaffle/lists"}