{"id":18310885,"url":"https://github.com/jimschubert/tweeter.js","last_synced_at":"2025-04-05T18:31:45.322Z","repository":{"id":57382616,"uuid":"2319361","full_name":"jimschubert/tweeter.js","owner":"jimschubert","description":"A wrapper around the twitter API written for node.js","archived":false,"fork":false,"pushed_at":"2011-09-24T14:51:15.000Z","size":160,"stargazers_count":4,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-21T08:34:58.662Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://jimschubert.github.com/tweeter.js/tweeter.html","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/jimschubert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-09-03T14:43:04.000Z","updated_at":"2021-09-25T09:16:43.000Z","dependencies_parsed_at":"2022-09-01T04:01:58.640Z","dependency_job_id":null,"html_url":"https://github.com/jimschubert/tweeter.js","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimschubert%2Ftweeter.js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimschubert%2Ftweeter.js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimschubert%2Ftweeter.js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jimschubert%2Ftweeter.js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jimschubert","download_url":"https://codeload.github.com/jimschubert/tweeter.js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247383883,"owners_count":20930365,"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":[],"created_at":"2024-11-05T16:15:48.022Z","updated_at":"2025-04-05T18:31:44.959Z","avatar_url":"https://github.com/jimschubert.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# tweeter.js\nA node.js wrapper around the twitter API :)\n\n# Installation\n\n## From npm\nYou can easily install tweeter.js from the npm repository:\n\n    $ npm install tweeter\n\nThis will install tweeter into `./node_modules/tweeter`.\n\n## From the Respository\nFirst, clone the repository:\n\n    $ git clone git@github.com:jimschubert/tweeter.js.git\n    $ cd tweeter.js\n\nTo get started, first, run:\n\n    $ make create_conf\n\nThen, edit `conf.js` and update it with your `consumerKey`, `consumerSecret`, and `oauthCallback`.\n\nNow, you're ready to open a node REPL environment and start playing with tweeter.js.\n\nFully annotated source is available [here](http://jimschubert.github.com/tweeter.js/tweeter.html)\n\n# Testing\ntweeter.js uses nodeunit for testing.  Be sure to install dependencies via npm:\n\n    $ npm install -d\n\nThis will install all dependencies as specified in `package.json`.\n\nYou can then run tests:\n\n    $ node test/tweeter.test.js\n\nThe test currently opens `google-chrome` and directs to Twitter's authentication page for the application you've specified in `./conf` (created in the previous section).  It then calls `tweeter.get('/1/statuses/home_timeline.json',...` and dumps the results to the response of the locally running server.\n\n# Documentation\ntweeter.js documentation is created using [docco](https://github.com/jashkenas/docco).  \nFirst, install Pygments. Follow the instructions on [Pygment's download](http://pygments.org/download/) site.\nThen, install CoffeeScript:\n\n    sudo npm install -g coffee-script\n\nFinally, install docco:\n\n    sudo npm install -g docco\n\nYou may choose to leave off the `-g` option if you don't want to install globally.\n\n# Mixin strategy\ntweeter.js uses a 'mixin strategy' for applying API wrappers. I'm not sure that 'mixin strategy' is the correct name for this.\n\nYou may choose to only include tweeter.js:\n\n    var Tweeter = require('tweeter');\n    var conf = require('./my_config');\n    var tweeter = new Tweeter(conf);\n\n    tweeter.get('/1/statuses/home_timeline', function(err,data) {\n        // do something\n    });\n\nYou may also choose to include some of the wrappers:\n\n    var Tweeter = require('tweeter');\n    var conf = require('./my_config');\n    require('tweeter/lib/tweeter.lists')(Tweeter);\n    require('tweeter/lib/tweeter.timelines')(Tweeter);\n\n    var tweeter = new Tweeter(conf);\n\n    tweeter.api.timelines.home_timeline(function(err,data) {\n        // do something\n    });\n\nThese wrappers will throw an `Error` if required options are missing, so they provide a huge benefit over hard-coded API calls.\n\n# License\n\ntweeter.js is Copyright 2011, Jim Schubert and is released under the [MIT License](http://bit.ly/mit-license)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimschubert%2Ftweeter.js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjimschubert%2Ftweeter.js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjimschubert%2Ftweeter.js/lists"}