Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 1.37 KB

README.md

File metadata and controls

35 lines (25 loc) · 1.37 KB

sfm-utils

Utilities for Social Feed Manager.

Build Status

Most significantly:

  • BaseConsumer: Base class for consuming messages from Rabbit.
  • BaseHarvester: Base class for a harvester, allowing harvesting from a queue or from a file.
  • StreamConsumer: A consumer intended to control stream harvests using Supervisor.
  • warced: An entry/exit wrapper for warcprox.

Installing

git clone https://github.com/gwu-libraries/sfm-utils.git
cd sfm-utils
pip install -r requirements/requirements.txt

Note that requirements/requirements.txt references the latest releast of warcprox-gwu. If you are doing development on the interaction between warcprox-gwu and sfm-utils, using requirements/dev.txt. This uses a local copy (../warcprox) of warcprox-gwu in editable mode.

Alternatively, it can be included as a dependency by adding the following to requirements.txt:

#Replace 0.1.0 with the version that you want.
git+https://github.com/gwu-libraries/[email protected]#egg=sfmutils
#If using any of the consumers or harvesters
librabbitmq==1.6.1
#If using BaseHarvester    
git+https://github.com/gwu-libraries/warcprox.git@master#egg=warcprox-gwu

Unit tests

python -m unittest discover