refactor name

Author: Favio Medrano

README.md

@@ -2,7 +2,7 @@
 
 ## About
 
-pyerddap is a API implementation for the ERDDAP server.
+erddap-python is a python API implementation for the ERDDAP server.
 
 ERDDAP is a data server that gives you a simple, consistent way to download subsets of gridded and tabular scientific datasets in common file formats and make graphs and maps. 
 
@@ -12,13 +12,13 @@ ERDDAP is a data server that gives you a simple, consistent way to download subs
 Using pip:
 
 ```
-$ pip install pyerddap
+$ pip install erddap-python
 ```
 
 ## Usage
 
 ```
-from pyerddap import ERDDAP_Tabledap
+from erddapClient import ERDDAP_Tabledap
 
 url = 'https://coastwatch.pfeg.noaa.gov/erddap'
 datasetid = 'cwwcNDBCMet'

erddapClient/__init__.py

@@ -0,0 +1,6 @@
+from erddapClient.erddap_server import ERDDAP
+from erddapClient.erddap_dataset import ERDDAP_Dataset
+from erddapClient.erddap_tabledap import ERDDAP_Tabledap
+from erddapClient.erddap_griddap import ERDDAP_Griddap
+
+__all__ = ["ERRDAP", "ERDDAP_Dataset", "ERDDAP_Tabledap", "ERDDAP_Griddap"]

erddapClient/__pycache__/__init__.cpython-37.pyc

@@ -1,15 +1,17 @@
 import os
-from pyerddap import url_operations
-from pyerddap.remote_requests import urlread
-from pyerddap.parse_utils import parseDictMetadata, parseConstraintValue
-from pyerddap.formatting import dataset_repr, simple_dataset_repr
+from erddapClient import url_operations
+from erddapClient.remote_requests import urlread
+from erddapClient.parse_utils import parseDictMetadata, parseConstraintValue
+from erddapClient.formatting import dataset_repr, simple_dataset_repr
 import datetime as dt
 
 
 class ERDDAP_Dataset:
 
   DEFAULT_FILETYPE = 'csvp'
-  BINARY_FILETYPES = [ 'dods', 'mat', 'nc', 'ncCF', 'ncCFMA', 'wav' ]
+  BINARY_FILETYPES = [ 'dods', 'mat', 'nc', 'ncCF', 'ncCFMA', 'wav', 
+                       'smallPdf', 'pdf', 'largePdf', 
+                       'smallPng', 'png', 'largePng', 'transparentPng']
 
   def __init__(self, erddapurl, datasetid, protocol='tabledap', auth=None, lazyload=True):
     self.erddapurl = erddapurl
@@ -118,7 +120,7 @@ def getBaseURL(self, filetype=DEFAULT_FILETYPE):
 
   def getAttribute(self, attribute, variableName='NC_GLOBAL'):
     self.loadMetadata()
-    for rowAttribute in self.metadata:
+    for rowAttribute in self.__info:
       if rowAttribute['Variable Name'] == variableName and rowAttribute['Attribute Name'] == attribute:
           return rowAttribute['Value']
 
@@ -127,11 +129,11 @@ def loadMetadata(self):
     if self.metadata is None:
       rawRequest = urlread(self.getMetadataURL(), auth=self.erddapauth)
       rawRequestJson = rawRequest.json()
-      self.metadata, self.variables =  parseDictMetadata(rawRequestJson)
+      self.__info, self.variables, self.metadata =  parseDictMetadata(rawRequestJson)
 
 
-  def getMetadataURL(self, request_format='json'):
-    return os.path.join(self.erddapurl, "info", self.datasetid , "index." + request_format )
+  def getMetadataURL(self, filetype='json'):
+    return os.path.join(self.erddapurl, "info", self.datasetid , "index." + filetype )
 
 
   def clearConstraints(self):
@@ -160,99 +162,3 @@ def getDataRequest(self, filetype=DEFAULT_FILETYPE, request_kwargs={}):
       return rawRequest.text
 
 
-  # Server side functions wrappers
-
-  def addVariablesWhere(self, attributeName, attributeValue):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#addVariablesWhere
-    '''
-    self.serverSideFunctions.append( 
-      'addVariablesWhere("{}","{}")'.format(attributeName, attributeValue) 
-    )
-    return self
-
-  def distinct(self):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#distinct
-    '''
-    self.serverSideFunctions.append( 'distinct()' )
-    return self
-  
-  def units(self, value):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#units
-    '''
-    self.serverSideFunctions.append( 'units({})'.format(value) )
-
-  def orderBy(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderBy
-    '''
-    self.addServerSideFunction('orderBy', variables)
-    return self
-  
-  def orderByClosest(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByClosest
-    '''
-    self.addServerSideFunction('orderByClosest', variables)
-    return self
-
-  def orderByCount(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByCount
-    '''
-    self.addServerSideFunction('orderByCount', variables)
-    return self    
-
-  def orderByLimit(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByLimit
-    '''
-    self.addServerSideFunction('orderByLimit', variables)
-    return self
-
-  def orderByMax(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMax
-    '''    
-    self.addServerSideFunction('orderByMax', variables)
-    return self    
-
-  def orderByMin(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMin
-    ''' 
-    self.addServerSideFunction('orderByMin', variables)
-    return self    
-
-  def orderByMinMax(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMinMax
-    '''    
-    self.addServerSideFunction('orderByMinMax', variables)
-    return self  
-
-  def orderByMean(self, variables):
-    '''
-     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMean
-    '''    
-    self.addServerSideFunction('orderByMean', variables)
-    return self     
-
-  def addServerSideFunction(self, functionName, arguments):
-    self.serverSideFunctions.append(
-      "{}(\"{}\")".format(
-        functionName, self.parseListOrStrToCommaSeparatedString(arguments)
-      )
-    )
-
-
-  def parseListOrStrToCommaSeparatedString(self, listorstring):
-    if type(listorstring) is list:
-      return ','.join(listorstring)
-    else:
-      return listorstring        
-
-
-

erddapClient/__pycache__/__init__.cpython-38.pyc

@@ -0,0 +1,24 @@
+from erddapClient.erddap_dataset import ERDDAP_Dataset
+import xarray as xr 
+import requests
+
+class ERDDAP_Griddap(ERDDAP_Dataset):
+
+  DEFAULT_FILETYPE = 'nc'
+
+  def __init__(self, url, datasetid, auth=None, lazyload=True):
+    super().__init__(url, datasetid, 'griddap', auth, lazyload=lazyload)
+
+
+  @property
+  def xarray(self):
+    if not hasattr(self,'__xarray'):      
+      if self.erddapauth:
+        session = requests.Session()
+        session.auth = self.erddapauth
+        store = xr.backends.PydapDataStore.open(self.getBaseURL('opendap'),
+                                                session=session)
+        self.__xarray = xr.open_dataset(store)
+      else:
+        self.__xarray = xr.open_dataset(self.getBaseURL('opendap'))
+    return self.__xarray

erddapClient/__pycache__/erddap_dataset.cpython-37.pyc

@@ -1,12 +1,12 @@
 import os
 from urllib.parse import quote_plus
-from pyerddap import url_operations
-from pyerddap.formatting import erddap_search_results_repr
-from pyerddap.parse_utils import parseConstraintValue, parseConstraintDateTime, parseSearchResults
-from pyerddap.remote_requests import urlread
-from pyerddap.erddap_dataset import ERDDAP_Dataset
-from pyerddap.erddap_tabledap import ERDDAP_Tabledap
-from pyerddap.erddap_griddap import ERDDAP_Griddap
+from erddapClient import url_operations
+from erddapClient.formatting import erddap_search_results_repr, erddap_server_repr
+from erddapClient.parse_utils import parseConstraintValue, parseConstraintDateTime, parseSearchResults
+from erddapClient.remote_requests import urlread
+from erddapClient.erddap_dataset import ERDDAP_Dataset
+from erddapClient.erddap_tabledap import ERDDAP_Tabledap
+from erddapClient.erddap_griddap import ERDDAP_Griddap
 
 
 class ERDDAP_SearchResults(list):
@@ -20,15 +20,47 @@ def results(self):
 
 class ERDDAP:
 
-    ALLDATASETS_VARIABLES = ['datasetID','accessible','institution','dataStructure','cdm_data_type','class','title','minLongitude','maxLongitude','longitudeSpacing','minLatitude','maxLatitude','latitudeSpacing','minAltitude','maxAltitude','minTime','maxTime','timeSpacing','griddap','subset','tabledap','MakeAGraph','sos','wcs','wms','files','fgdc','iso19115','metadata','sourceUrl','infoUrl','rss','email','testOutOfDate','outOfDate','summary']
+    ALLDATASETS_VARIABLES = [ 'datasetID','accessible','institution','dataStructure',
+                              'cdm_data_type','class','title','minLongitude','maxLongitude',
+                              'longitudeSpacing','minLatitude','maxLatitude','latitudeSpacing',
+                              'minAltitude','maxAltitude','minTime','maxTime','timeSpacing',
+                              'griddap','subset','tabledap','MakeAGraph','sos','wcs','wms',
+                              'files','fgdc','iso19115','metadata','sourceUrl','infoUrl',
+                              'rss','email','testOutOfDate','outOfDate','summary' ]
 
     def __init__(self, url, auth=None, lazyload=True):
         self.serverURL = url 
         self.auth = auth
         self.tabledapAllDatasets = ERDDAP_Dataset(self.serverURL, 'allDatasets', auth=auth)
 
+    def __repr__(self):
+        return erddap_server_repr(self)
+
+    @property
+    def version(self):
+        if not hasattr(self,'__version'):
+            try:
+                req = urlread( os.path.join(self.serverURL, 'version'), self.auth)
+                __version = req.text
+                __version = __version.replace("\n", "")
+            except:
+                __version = 'ERDDAP_version=<1.22'
+            return __version
+
+    @property
+    def version_string(self):
+        if not hasattr(self,'__version_string'):
+            try:
+                 req = urlread( os.path.join(self.serverURL, 'version_string'), self.auth)
+                 __version_string = req.text
+                 __version_string = __version_string.replace("\n", "")
+            except:
+                __version_string = 'ERDDAP_version_string=<1.80'
+            return __version_string
 
     def advancedSearch(self, **filters):
+        """
+        """
 
         searchURL = self.getSearchURL( **filters)
         rawSearchResults = urlread(searchURL, self.auth)

erddapClient/__pycache__/erddap_dataset.cpython-38.pyc

@@ -0,0 +1,114 @@
+from erddapClient.erddap_dataset import ERDDAP_Dataset
+from erddapClient.formatting import dataset_repr
+from io import StringIO
+import pandas as pd
+
+
+class ERDDAP_Tabledap(ERDDAP_Dataset):
+
+  DEFAULT_FILETYPE = 'csvp'
+
+  def __init__(self, url, datasetid, auth=None, lazyload=True):
+    super().__init__(url, datasetid, 'tabledap', auth, lazyload=lazyload)
+
+
+  def getDataFrame(self, request_kwargs={}, **kwargs):
+    csvpdata = self.getDataRequest('csvp', **request_kwargs)
+    return pd.read_csv(StringIO(csvpdata), **kwargs)
+
+  # 
+  # Tabledap server side functions wrappers
+  # 
+  def addVariablesWhere(self, attributeName, attributeValue):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#addVariablesWhere
+    '''
+    self.serverSideFunctions.append( 
+      'addVariablesWhere("{}","{}")'.format(attributeName, attributeValue) 
+    )
+    return self
+
+  def distinct(self):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#distinct
+    '''
+    self.serverSideFunctions.append( 'distinct()' )
+    return self
+  
+  def units(self, value):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#units
+    '''
+    self.serverSideFunctions.append( 'units({})'.format(value) )
+
+  def orderBy(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderBy
+    '''
+    self.addServerSideFunction('orderBy', variables)
+    return self
+  
+  def orderByClosest(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByClosest
+    '''
+    self.addServerSideFunction('orderByClosest', variables)
+    return self
+
+  def orderByCount(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByCount
+    '''
+    self.addServerSideFunction('orderByCount', variables)
+    return self    
+
+  def orderByLimit(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByLimit
+    '''
+    self.addServerSideFunction('orderByLimit', variables)
+    return self
+
+  def orderByMax(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMax
+    '''    
+    self.addServerSideFunction('orderByMax', variables)
+    return self    
+
+  def orderByMin(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMin
+    ''' 
+    self.addServerSideFunction('orderByMin', variables)
+    return self    
+
+  def orderByMinMax(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMinMax
+    '''    
+    self.addServerSideFunction('orderByMinMax', variables)
+    return self  
+
+  def orderByMean(self, variables):
+    '''
+     https://coastwatch.pfeg.noaa.gov/erddap/tabledap/documentation.html#orderByMean
+    '''    
+    self.addServerSideFunction('orderByMean', variables)
+    return self     
+
+  def addServerSideFunction(self, functionName, arguments):
+    self.serverSideFunctions.append(
+      "{}(\"{}\")".format(
+        functionName, self.parseListOrStrToCommaSeparatedString(arguments)
+      )
+    )
+
+
+  def parseListOrStrToCommaSeparatedString(self, listorstring):
+    if type(listorstring) is list:
+      return ','.join(listorstring)
+    else:
+      return listorstring        
+
+