Metadata-Version: 2.1
Name: twistream
Version: 0.1
Summary: Automate Twitter Stream data collection
Home-page: https://github.com/guillermo-carrasco/twistream
Author: Guillermo Carrasco
Author-email: guille.ch.88@gmail.com
License: UNKNOWN
Keywords: Social Media,Twitter,Data Mining,Data Collection
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: pytest
Requires-Dist: pyyaml
Requires-Dist: sqlalchemy
Requires-Dist: tweepy

# Twistream: Twitter Stream API data collection

[![CircleCI](https://circleci.com/gh/guillermo-carrasco/twistream.svg?style=svg)](https://circleci.com/gh/circleci/circleci-docs)

Twistream helps you automatically collect and store data from Twitter Stream API.

## Installation

From source:

    git clone https://github.com/guillermo-carrasco/twistream.git
    cd twistream
    pip install .

From PyPi:

    pip install twistream

### Setting up

You need your twitter credentials in order to be able to use Twitter API. For that,
create an application [here](https://apps.twitter.com). Once created, create a configuration
file and add the credentials there:

```
~> cat ~/.twistream/twistream.yml      

twitter:                  
  consumer_key: your_consumer_key                   
  consumer_secret: your_consumer_secret             
  access_token_key: your_access_token_key             
  access_token_secret: your_access_token_secret       


backend: backend_name                  

backend_params:
    username: db_username
    password: db_password
```

#### Different backends
Right now twistream only supports sqlite, the backend and backend sections in your
configuration file should look like this:

```
backend: sqlite

backend_params:
    db: /path/to/your/db
```

## Usage
Once you have createed the configuration file, just execute:

```
twistream --hashtags hashtags,to,follow
```

