PyOpenFec
A Python wrapper for the OpenFEC API. Documentation for this API can be found here
Installation
- Clone this repository
git clone https://github.com/jeremyjbowers/pyopenfec.git
- navigate into the new directory
cd pyopenfec
-
(optional) start the virtual environment you'd like to install to
-
run
python setup.py install
Dependencies include six and requests (will be installed by setup.py)
Examples
Candidates
Candidate
The Candidate class holds fields for each candidate in the OpenFEC API.
A number of class and instance methods are available.
count
The Candidate.count() method will return the number of Candidate objects available for a given query. Note: This method returns an integer representing the number of items available in the OpenFEC API. It does not return a list of objects.
from pyopenfec import Candidate
candidate_count = Candidate.count(cycle=2016, office="P", candidate_status="C")
fetch
The Candidate.fetch() method will return a list of Candidate objects available for a given query. This method will automatically page through the results and return all objects available in the OpenFEC API.
from pyopenfec import Candidate
candidate_count = Candidate.count(cycle=2016, office="P", candidate_status="C")
candidates = Candidate.fetch(cycle=2016, office="P", candidate_status="C")
for candidate in candidates:
print("{name}, {party}".format(name=candidate.name, party=candidate.party))
Committees
tktk
Reports
tktk
