Metadata-Version: 2.1
Name: Twimer
Version: 0.0.2
Summary: Stream Tweets into Your Favorite Databases
Home-page: https://github.com/owhadi/twimer
Author: Moein Owhadi Kareshk
Author-email: moein.owhadi@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: atomicwrites (==1.4.0)
Requires-Dist: attrs (==19.3.0)
Requires-Dist: certifi (==2020.4.5.1)
Requires-Dist: chardet (==3.0.4)
Requires-Dist: colorama (==0.4.3)
Requires-Dist: dnspython (==1.16.0)
Requires-Dist: idna (==2.9)
Requires-Dist: more-itertools (==8.4.0)
Requires-Dist: oauthlib (==3.1.0)
Requires-Dist: packaging (==20.4)
Requires-Dist: pluggy (==0.13.1)
Requires-Dist: py (==1.9.0)
Requires-Dist: pymongo (==3.10.1)
Requires-Dist: pyparsing (==2.4.7)
Requires-Dist: PySocks (==1.7.1)
Requires-Dist: pytest (==5.4.3)
Requires-Dist: requests (==2.23.0)
Requires-Dist: requests-oauthlib (==1.3.0)
Requires-Dist: six (==1.15.0)
Requires-Dist: tweepy (==3.8.0)
Requires-Dist: urllib3 (==1.25.9)
Requires-Dist: wcwidth (==0.2.5)

# twimer
Stream Tweets into Your Favorite Databases

[![Build Status](https://circleci.com/gh/owhadi/twimer.svg)](https://app.circleci.com/pipelines/github/owhadi)

Analyzing tweets reveals very interesting insights about events in a specific time and location, people's opinions 
about the news, etc.
We, therefore, aim to make the data collection easier for you so you can focus on your analysis only!

twimer helps you to store tweets with certain keywords and from specific geographic regions into JSON files or database systems in an easy way.

## Twitter API
To use this project, you need to obtain _CONSUMER_KEY_, _CONSUMER_SECRET_, _ACCESS_TOKEN_, _ACCESS_TOKEN_SECRET_ 
from [Twitter Developer](https://developer.twitter.com/en).

## Installation
Simply install this package by running the following command:
 ```bash
pip install twimer 
```

## Usage
In the current version, you can stream the tweets using their keywords and store them in files (JSON and JSON.tar.gz)
and MongoDB databases.

To store the tweets as JSON (tar.gz) files into `my_path` directory:
```python
import twimer

stream_tweet = twimer.Twimer(CONSUMER_KEY, 
                             CONSUMER_SECRET, 
                             ACCESS_TOKEN, 
                             ACCESS_TOKEN_SECRET, 
                             storage_method='file/targz', 
                             file_path=my_path)
stream_tweet.start_streaming(filters=['keyword1', 'keyword2'])
```

And to store the tweets in a MongoDB database using url `my_url`:
```python
import twimer

stream_tweet = twimer.Twimer(CONSUMER_KEY, 
                             CONSUMER_SECRET, 
                             ACCESS_TOKEN, 
                             ACCESS_TOKEN_SECRET, 
                             storage_method='mongodb', 
                             mongo_url=mongo_url)
stream_tweet.start_streaming(filters=['keyword1', 'keyword2'])
```

The `my_url` is in _mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]_ format.

## Contribution
You are very welcome to contribute to this project with your code (as pull-requests), mention the bugs or ask for new 
features (as GitHub Issues), or just telling your friend about it! 




