Merge pull request #906 from earthlab/apppears

Apppears

Author: eculler

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.testing.pytestArgs": [
+        "earthpy/tests"
+    ]
+}

CONTRIBUTORS.rst

@@ -6,7 +6,6 @@ Maintainers
 
 EarthPy is maintained by a core group of Python enthusiasts at Earth Lab - University of Colorado, Boulder
 
-* Nathan Korinek (@nkorinek)
 * Elsa Culler (@eculler)
 
 Contributors
@@ -20,5 +19,5 @@ package.
 * Joseph McGlinchy (@joemcglinchy)
 * Jenny Palomino (@jlpalomino)
 * Max Joseph (@mbjoseph)
-* Joseph McGlinchy (@joemcglinchy)
-* Jenny Palomino (@jlpalomino)
+* Nathan Korinek (@nkorinek)
+* Elsa Culler (@eculler)

ci/py310-env.yml

@@ -7,6 +7,9 @@ dependencies:
   # Core scientific python
   - matplotlib
   - scipy
+  # System management
+  - keyring
+  - platformdirs
 
   # Geo stuff
   - geopandas

ci/py311.yml

@@ -0,0 +1,26 @@
+name: earthpy-dev
+channels:
+  - conda-forge
+dependencies:
+
+  - python=3.11
+  # Core scientific python
+  - matplotlib
+  - scipy
+  # System management
+  - keyring
+  - platformdirs
+
+  # Geo stuff
+  - geopandas
+  - rasterio
+  - folium
+  - pytest-vcr
+  - pytest-cov
+  - pytest
+  - setuptools
+  - descartes
+  - seaborn
+  - pillow
+  - scikit-image
+  - requests

ci/py312.yml

@@ -0,0 +1,26 @@
+name: earthpy-dev
+channels:
+  - conda-forge
+dependencies:
+
+  - python=3.12
+  # Core scientific python
+  - matplotlib
+  - scipy
+  # System management
+  - keyring
+  - platformdirs
+
+  # Geo stuff
+  - geopandas
+  - rasterio
+  - folium
+  - pytest-vcr
+  - pytest-cov
+  - pytest
+  - setuptools
+  - descartes
+  - seaborn
+  - pillow
+  - scikit-image
+  - requests

ci/py38-env.yml

@@ -7,6 +7,9 @@ dependencies:
   # Core scientific python
   - matplotlib
   - scipy
+  # System management
+  - keyring
+  - platformdirs
 
   # Geo stuff
   - geopandas

ci/py39-env.yml

@@ -7,6 +7,9 @@ dependencies:
   # Core scientific python
   - matplotlib
   - scipy
+  # System management
+  - keyring
+  - platformdirs
 
   # Geo stuff
   - geopandas

earthpy/__init__.py

@@ -7,6 +7,7 @@
 import importlib.resources
 import json
 from .io import Data
+from .project import Project
 
 data = Data()
 """

earthpy/api/__init__.py

@@ -0,0 +1,71 @@
+"""
+earthpy.api
+================
+
+A module to download data using various APIs.
+
+"""
+
+import getpass
+import json
+import logging
+import os
+import pathlib
+import re
+import secrets
+import time
+from glob import glob
+
+import keyring
+import requests
+import sqlite3
+
+from ..project import Project
+
+class APIDownloader(object):
+    """
+    Parent class to download data from APIs
+
+    Parameters
+    ----------
+    download_label : str, optional
+        Label used in data_dir and as the API job label
+    project_dir : pathlike, optional
+        Replacement directory for ~/earth-analytics/data/
+    date_template: pd.DatetimeIndex
+        Match date range with an existing DatetimeIndex
+    start_date : date-like, optional
+        Start date, parseable by pd.to_datetime(). Default
+        is the most recent
+    end_date : date-like, optional
+        End date, parseable by pd.to_datetime()
+    start_doy : str, optional
+        Day of the year to start a recurring date range
+    end_doy : str, optional
+        Day of the year to end a recurring date range
+    months : iterable of str or int, optional
+        Iterable of month names or numbers.
+    seasons : str, optional
+        Names of seasons to download on an annually recurring basis.
+        Seasons correspond to pandas DateTimeOffset conventions.
+    start_year : str or int
+        Start year for annually recurring dates, as YYYY or 'YYYY'
+    end_year : str or int
+        End year for annually recurring dates, as YYYY or 'YYYY'
+    area_of_interest : gpd.GeoDataFrame, shapely geometry, or bounding box, optional
+        The spatial boundary to subset. Bounding boxes should
+        match GeoDataFrame.total_bounds style.
+    auth_method : 
+        
+    Attributes
+    ----------
+    base_url : str
+        The API endpoint url
+    data_dir : pathlike
+        Path to store data in. Default: ~/earth-analytics/data/{project_dir}
+    download_label : str
+        Label used in data_dir and as the API job label.
+    """
+    
+    base_url = NotImplemented
+    download_key = NotImplemented