Installation

Quick Installation

Quick steps to install and start Twitcher:

$ git clone https://github.com/bird-house/twitcher.git
$ cd twitcher
$ conda env create
$ conda activate twitcher
$ make install
$ make migrate
$ make start

From GitHub Sources

Get Twitcher source from GitHub:

$ git clone https://github.com/bird-house/twitcher.git
$ cd twitcher

Create Conda environment named twitcher:

$ conda env update -f environment.yml
$ conda activate twitcher

Install the Twitcher app:

$ pip install -e .
OR
make install

For development you can use this command:

$ pip install -e .[dev]
OR
$ make develop

Initialize Database

Before you can start the service you need to initialize or upgrade the database:

$ make migrate

Starting Twitcher Service

For development twitcher is using the the waitress WSGI server.

Start the twitcher service using the development.ini configuration:

$ pserve development.ini --reload
OR
$ make start