https://github.com/mattdeboard/python-usdol

Python wrapper for US Dept. of Labor API
https://github.com/mattdeboard/python-usdol

Last synced: 23 days ago
JSON representation

Python wrapper for US Dept. of Labor API

• Host: GitHub
• URL: https://github.com/mattdeboard/python-usdol
• Owner: mattdeboard
• Created: 2011-07-22T02:19:32.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2012-10-17T03:47:11.000Z (about 12 years ago)
• Last Synced: 2024-04-17T09:52:30.620Z (7 months ago)
• Language: Python
• Homepage:
• Size: 136 KB
• Stars: 7
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
==============

Python-USDOL

==============

Python wrapper for the US Dept. of Labor's `developer API `_. 

-----

Usage

-----

Usage is straightforward::

  import python_usdol

  conn = python_usdol.Connection(token='mytoken', secret='mysharedsecret')

  

  data = conn.fetch_data('FAQ', 'Topic')

Where 'FAQ' and 'Topic' are the names of the targeted dataset and table within the dataset, respectively. For a full list of datasets and tables, please consult the Dept. of Labor's developer website, linked above.

``fetch_data`` returns a dictionary, with a key for each column on the database you've specified, with an additional ``__metadata`` key.

Some datasets have "multipart" names, e.g. the `Consumer Expenditure Survey Dataset `_. In this case, since the base url is ``http://api.dol.gov/V1/Statistics/ConsumerExpenditure``, vice e.g. ``.../V1/FORMS``, for the first argument to fetch data, you would pass the "multipart" Agency name::

  data = conn.fetch_data('Statistics/ConsumerExpenditure', '')

-----------

Parameters

-----------

Python-USDOL has support for the following methods outlined in the DOL's `API Access Guide `_:

- ``$metadata``

- ``$top``

- ``$skip``

- ``$orderby``

- ``$filter``

------

Filter

------

Using the filter method goes thusly::

  data = conn.fetch_data("FAQ", "Topic", filter_="TopicID eq 5")

Since ``filter`` is a keyword in Python, Python-USDOL uses ``filter_`` in its place.

------

Future

------

Please help make this API better for everyone by reporting bugs, forking and submitting patches.