pygouv 0.0.3

API wrapper for data.gouv.fr

pygouv

pygouv is a Python API wrapper for data.gouv.fr, the French Official Open Data Portal.

Installation

pip install pygouv

Usage

import pygouv as gv

gv.home()

Displays the most important information about the datasets that are currently displayed within the home page of the data.gouv.fr portal.

gv.home()

gv.search()

Searches for specific data sets through the data.gouv API according to the pattern provided into the query argument.

gv.search(query = 'paris', n_pages=20)

gv.explain()

Provides in French a detailed description of a data set.

# mind that we're using the print function so that we get a well formatted text
print(gv.explain(dataset_id = '5f2bc22ff6bf657d74f48375'))

gv.resources()

The data.gouv API provides access to several data sets in which one can find several individual data frames to exploit. The BARIS_resources lists all the data frames available within a specific data set along with the main information concerning the data frames.

gv.resources(dataset_id = '5f2bc22ff6bf657d74f48375')

Developing pygouv

To install pygouv along with the tools that you need to develop and run tests, run the following in your virtualenv:

$ pip install -e .[dev]

Code of Conduct

Please note that the pygouv project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.