From ec25a78344c7ff372e9cdbebd080e0cac78e99e0 Mon Sep 17 00:00:00 2001
From: Vitor Baptista <vitor@vitorbaptista.com>
Date: Mon, 30 Nov 2015 20:37:32 +0000
Subject: [PATCH] [#9] Add example of working with a datapackage

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7afeea4..2105195 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-DataPackage.py
-==============
+# DataPackage.py
 
 [![Build Status](https://travis-ci.org/okfn/datapackage-py.svg)](https://travis-ci.org/okfn/datapackage-py)
 [![Test Coverage](https://coveralls.io/repos/okfn/datapackage-py/badge.svg?branch=master&service=github)](https://coveralls.io/github/okfn/datapackage-py)
@@ -9,3 +8,29 @@ DataPackage.py
 A model for working with [Data Packages].
 
   [Data Packages]: http://dataprotocols.org/data-packages/
+
+## Example
+
+```python
+import datapackage
+
+dp = datapackage.DataPackage('http://data.okfn.org/data/core/gdp')
+brazil_gdp = [{'Year': int(row['Year']), 'Value': float(row['Value'])}
+              for row in dp.resources[0].data if row['Country Code'] == 'BRA']
+
+max_gdp = max(brazil_gdp, key=lambda x: x['Value'])
+min_gdp = min(brazil_gdp, key=lambda x: x['Value'])
+percentual_increase = max_gdp['Value'] / min_gdp['Value']
+
+msg = (
+    'The highest Brazilian GDP occured in {max_gdp_year}, when it peaked at US$ '
+    '{max_gdp:1,.0f}. This was {percentual_increase:1,.2f}% more than its '
+    'minimum GDP in {min_gdp_year}.'
+).format(max_gdp_year=max_gdp['Year'],
+         max_gdp=max_gdp['Value'],
+         percentual_increase=percentual_increase,
+         min_gdp_year=min_gdp['Year'])
+
+print(msg)
+# The highest Brazilian GDP occured in 2011, when it peaked at US$ 2,615,189,973,181. This was 172.44% more than its minimum GDP in 1960.
+```