Skip to content

isabella232/recalls-python

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 

Repository files navigation

Python wrapper for USA.gov Product Recalls Data API. http://search.usa.gov/api/recalls

Usage example:


from api import RecallsAPI
foo = RecallsAPI(api_key='9c63bbbfcd985314b245ef92ab37a792')
foo.search(query='tires')

If you give an incorrect API key, you will get an error like so:


ValueError: No JSON object could be decoded

No API key is actually needed for this API


from api import RecallsAPI
bar = RecallsAPI()
bar.search(query='tires')

24 Jun 2011
Todo: add error checking e.g. for incorrect API key

Third Party Libraries
---------------------

Current third-party libraries we're using include:

* `mock` -- Create test stubs and mocks.

    >>> from mock import Mock
    >>> from api import api
    >>> api.urlopen = Mock()
  • coverage -- Check test code coverage.

    $ coverage run test.py
    .................
    -----------------
    Ran 17 tests in 0.010s

    $ coverage report -m
    Name                          Stmts   Miss  Cover   Missing
    -----------------------------------------------------------
    test                            113      0   100%   
    api/__init__                      2      0   100%   
    api/api                          42      0   100%   
    api/api_key                       2      0   100%   
    -----------------------------------------------------------
    TOTAL                           159      0   100%   
  • pep8 -- Check Python files are following the PEP 8 Style Guide.

    $ pep8 test.py
    test.py:12:1: E302 expected 2 blank lines, found 1

About

Python wrapper for usa.gov Product Recalls API

Resources

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%