|
|
# Getting started #
|
|
|
## Prerequisites ##
|
|
|
# Installation #
|
|
|
|
|
|
- python >= 2.7
|
|
|
- pip
|
|
|
- mongodb
|
|
|
- virtualenvwrapper or virutalenvwrapper-win if on windows (optional but highly recommended)
|
|
|
Install Twitter Tap using [pip](http://www.pip-installer.org/)
|
|
|
|
|
|
## Before you start ##
|
|
|
Please follow this link https://apps.twitter.com/ and create a twitter app. You will need the consumer key and consumer secret to access the twitter API.
|
|
|
|
|
|
## Installation ##
|
|
|
### Creating the environment ###
|
|
|
Create a virtual python environment for the project.
|
|
|
If you're not using virtualenv or virtualenvwrapper you may skip this step.
|
|
|
|
|
|
#### For virtualenvwrapper ####
|
|
|
```bash
|
|
|
mkvirtualenv --no-site-packages twitter-tap
|
|
|
pip install twitter-tap
|
|
|
```
|
|
|
|
|
|
#### For virtualenv ####
|
|
|
Or, if you want the current code
|
|
|
|
|
|
```bash
|
|
|
virtualenv --no-site-packages twitter-tap
|
|
|
git clone git://github.com/janezkranjc/twitter-tap.git
|
|
|
cd twitter-tap
|
|
|
source bin/activate
|
|
|
python setup.py install
|
|
|
```
|
|
|
|
|
|
### Clone the code ###
|
|
|
|
|
|
```bash
|
|
|
git clone git@github.com:janezkranjc/twitter-tap.git
|
|
|
```
|
|
|
# Before you start #
|
|
|
|
|
|
### Install requirements ###
|
|
|
Please follow this link https://apps.twitter.com/ and create a twitter app. You will need the consumer key and consumer secret to access the twitter API.
|
|
|
|
|
|
```bash
|
|
|
cd twitter-tap
|
|
|
pip install -r requirements.txt
|
|
|
```
|
|
|
# Using twitter tap #
|
|
|
|
|
|
### Copy and edit the settings file ###
|
|
|
Run Twitter Tap in the command line like this.
|
|
|
|
|
|
```bash
|
|
|
cp __settings.py settings.py
|
|
|
vi settings.py
|
|
|
tap
|
|
|
```
|
|
|
|
|
|
## Show help text ##
|
|
|
### Show help text ###
|
|
|
```bash
|
|
|
python tap.py -h
|
|
|
tap -h
|
|
|
```
|
|
|
|
|
|
## Executing a query ##
|
|
|
### Executing a query ###
|
|
|
|
|
|
To execute a query you must provide a **query**, the **consumer secret** and either the **consumer key** or the access token. Consumer key and secret can be obtained at the http://apps.twitter.com/ website, while the access token will be obtained when first connecting with the key and secret.
|
|
|
|
|
|
```bash
|
|
|
python tap.py -q "miley cyrus" -v DEBUG
|
|
|
tap --consumer-key CONSUMERKEY --consumer-secret CONSUMERSECRET -q "miley cyrus" -v DEBUG
|
|
|
``` |
|
|
\ No newline at end of file |