Skip to content

Latest commit

 

History

History
85 lines (56 loc) · 1.67 KB

README.md

File metadata and controls

85 lines (56 loc) · 1.67 KB
Raw

bieberhose Build Status

bieberhose header

Collect the latest buzz about 'bieber' from the Twitter firehose

Installation

bieberhose requires python>=3.6

Checkout the code:

git clone [email protected]:zeebonk/bieberhose.git
cd bieberhose

Create a new virtual environment via virtualenvwrapper:

mkvirtualenv -a . -p /usr/bin/python3.6 bieberhose

And install using pip:

pip install .

Usage

Before usage, bieberhose needs to be authenticated against the Twitter API. The authentication data is storted on disk and will be reused in future usage. Authentication is done via a Twitter app, of which a consumer key and secret need to be passed during authentication. This can be done via arguments:

bieberhose authenticate --consumer-key ... --consumer-secret ...

Or via environment variables:

COSUMER_KEY=... CONSUMER_SECRET=... bieberhose authenticate

After a succesfull authentication you can collect tweets by running:

bieberhose collect

For more advanced usage, run:

bieberhose collect --help

Development

Checkout the code:

git clone [email protected]:zeebonk/bieberhose.git
cd bieberhose

Install the package in editable mode and install development extras:

pip install -e .[dev]

Run all checks and tests:

black bieberhose tests  # Automatic formatter
isort  # Automatic formatter for imports
flake8  # Static checks
pytest  # Tests