Downloading and running birding


Existing streamparse projects should include the birding Python package instead of cloning the birding repository, which is described in Using birding in production.

The birding project fully automates dependencies for the purposes of development, demo, or light usage. In a terminal on a Unix-like system, clone the birding repository:

git clone
cd birding

Then run:

make run

The birding project makes every effort to detect if an underlying dependency is unmet. If make run fails, look for messages indicating what is missing or what went wrong. If an error message says that an address is in use, look for other processes on the system which are currently using the referenced network port, then shut them down in order to run birding. If an error is unclear, submit an issue including a build log and mention your operating system. To create a build.log:

make run 2>&1 | tee build.log

When birding is running, its console output is verbose as it includes all output of zookeeper, kafka, storm, and streamparse. Note that – as with all streamparse projects – output from the birding code itself ends up in the logs/ directory and not in the console. To stop running birding, issue a keyboard interrupt in the console with Control-C:


Using make run will pick up birding.yml as the project configuration file if it exists in the root directory next to the Makefile. See Configuring birding. This simple birding.yml to sets the search terms used by birding:

  - mocking bird
  - carrier pigeon

Data for the project ends up in a directory relative to the project root. Clean runtime data with:

make clean-data

Build docs with make docs and check for Python errors by static analysis with make flakes. Make allows multiple targets at once:

make clean-data flakes run

Next, goto one of: