Skip to content
This repository has been archived by the owner on Feb 1, 2020. It is now read-only.

Re using Billy

James McKinney edited this page May 1, 2013 · 8 revisions

You'll need Git, virtualenv and Python 2.7 or greater.

Setup

Replace PROJECT_NAME with your project's name.

mkdir PROJECT_NAME
cd PROJECT_NAME
mkvirtualenv PROJECT_NAME --system-site-packages
git init .

requirements.txt

-e git+http://github.com/sunlightlabs/billy.git#egg=billy
# Uncomment to use the boundary service:
#-e git+http://github.com/rhymeswithcycle/represent-boundaries.git#egg=represent-boundaries
# Uncomment to include OpenStates' scrapers:
#-e git+http://github.com/sunlightlabs/openstates.git#egg=openstates

billy_settings.py

# @see https://github.com/sunlightlabs/billy/blob/master/billy/core/default_settings.py
import os
import openstates

SCRAPER_PATHS = [
  os.path.join(os.path.dirname(os.path.abspath(__file__)), 'scrapers'),
  # Uncomment to include OpenStates' scrapers:
  #os.path.join(os.path.dirname(openstates.__file__)),
]

# Uncomment to use the boundary service:
#BOUNDARY_SERVICE_URL = 'http://127.0.0.1:8000/'

.gitignore

Replace APPNAME with your Django app's name.

*.pyc
/cache
/data/*
/src
/site/local_settings.py
# Uncomment if you are using the web interface:
#/site/APPNAME_site/APPNAME.sqlite3
# Uncomment if you are using the boundary service:
#!/data/shapefiles

Next steps

Run pip install -r requirements.txt. You can now create your scrapers directory and write scrapers! For now, see the OpenStates documentation.