Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Python wrapper for US Dept. of Labor API

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 .gitignore
Octocat-spinner-32 MANIFEST.in
Octocat-spinner-32 README.rst
Octocat-spinner-32 python_usdol.py
Octocat-spinner-32 setup.py
README.rst

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', '<desired table name>')

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.

Something went wrong with that request. Please try again.