Added docstrings

Author: fccoelho

docs/conf.py

@@ -47,7 +47,7 @@
 
 # General information about the project.
 project = 'GHOclient'
-copyright = "2020, Flávio Codeço Coelho"
+copyright = "2020-21, Flávio Codeço Coelho"
 author = "Flávio Codeço Coelho"
 
 # The version info for the project you're documenting, acts as replacement

ghoclient/ghoclient.py

@@ -17,20 +17,52 @@ def __init__(self):
         self.data = xmltodict.parse(resp.text)
 
     def get_available_datasets(self):
+        '''
+        Check for available datasets
+
+        Returns 
+        -------
+        datasets : list
+            list of datasets.
+
+        '''
         datasets = []
         for k, v in self.data['GHO']['Metadata'].items():
             if k == 'Dataset':
                 datasets.extend([d for d in v])
         return datasets
 
     def get_attributes(self):
+        '''
+        Lists attributes used on datasets
+
+        Returns
+        -------
+        attributes : list
+            list of attributes represented as dictionaries.
+
+        '''
         attributes = []
         for k, v in self.data['GHO']['Metadata'].items():
             if k == 'Attribute':
                 attributes.extend([d for d in v])
         return attributes
 
     def get_dimensions(self, format='dataframe'):
+        '''
+        List dimensions of data
+
+        Parameters
+        ----------
+        format : str, output format, of `dataframe` (default) or `list`
+            DESCRIPTION. The default is 'dataframe'.
+
+        Returns
+        -------
+        dimensions: dataframe or list
+            description of every variable in the datasets and their dimension.
+
+        '''
         dimensions = []
         for k, v in self.data['GHO']['Metadata'].items():
             if k == 'Dimension':
@@ -40,12 +72,35 @@ def get_dimensions(self, format='dataframe'):
         return dimensions
 
     def get_region_codes(self):
+        '''
+        Returns region codes
+
+        Returns
+        -------
+        regions : dictionary
+            Dictionary with code, description pairs.
+
+        '''
         url = BASE_URL + 'REGION'
         data = self._fetch_data_as_dict(url)
-        regions = [{c['@Label']: c['Display']} for c in data['GHO']['Metadata']['Dimension']['Code']]
+        regions = {c['@Label']: c['Display'] for c in data['GHO']['Metadata']['Dimension']['Code']}
         return regions
 
     def get_countries(self, format='dataframe'):
+        '''
+        Returns a dataframe with country codes and metadata
+
+        Parameters
+        ----------
+        format : str, optional
+            The default is 'dataframe'.
+
+        Returns list if `format` is full
+        -------
+        data: dataframe by default
+            country info.
+
+        '''
         url = BASE_URL + 'COUNTRY'
         data = self._fetch_data_as_dict(url)
         if format == 'dataframe':
@@ -96,9 +151,9 @@ def _fetch_data_as_dict(self, url):
 
     def get_data_codes(self, format='dataframe'):
         """
-        Get Codes That
+        Get Codes that can be fetched as indicators.
         :param format: either 'full', 'label' or 'url'
-        :return: list of dicts when format is full or a list of strings otherwise.
+        :return: list of dicts when `format` is 'full', a Dataframe when it is 'dataframe' or a list of strings otherwise.
         """
         url = BASE_URL + 'GHO'
         data = self._fetch_data_as_dict(url)

setup.py

@@ -49,6 +49,6 @@
     test_suite='tests',
     tests_require=test_requirements,
     url='https://github.com/fccoelho/ghoclient',
-    version='0.1.0',
+    version='1.0.2',
     zip_safe=False,
 )