From 41bd683c2cdd111ba302eaf358cc0a0e84fdb2f5 Mon Sep 17 00:00:00 2001 From: Ulf Aslak Date: Fri, 6 Dec 2019 12:56:33 +0100 Subject: [PATCH] Add a short docstring so users can go ?sensible_raw and get started easily. --- sensible_raw/__init__.py | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/sensible_raw/__init__.py b/sensible_raw/__init__.py index 989d825..3805f43 100644 --- a/sensible_raw/__init__.py +++ b/sensible_raw/__init__.py @@ -1 +1,8 @@ +"""API for loading data from the Sensible DTU database. + +Example usage: +-------------- +>>> from sensible_raw.loaders import loader +>>> df = loader.load_data("sms", "january_2014") +""" __author__ = 'radugatej'