windborne 1.2.1__py3-none-any.whl → 1.2.4__py3-none-any.whl

windborne/__init__.py

@@ -23,6 +23,7 @@ from .forecasts_api import (
     get_point_forecasts,
     get_initialization_times,
     get_forecast_hours,
+    get_generation_times,
 
     get_gridded_forecast,
     get_full_gridded_forecast,
@@ -61,7 +62,8 @@ __all__ = [
     "get_point_forecasts",
     "get_initialization_times",
     "get_forecast_hours",
-
+    "get_generation_times",
+    
     "get_gridded_forecast",
     "get_full_gridded_forecast",
     "get_temperature_2m",

windborne/api_request.py

@@ -21,99 +21,62 @@ def get_api_credentials():
 
 def verify_api_credentials(client_id, api_key):
     if not client_id and not api_key:
-        print("To access the WindBorne API, set your Client ID and API key by setting the environment variables WB_CLIENT_ID and WB_API_KEY.")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print("To get an API key, email data@windbornesystems.com.")
-        exit(80)
+        raise ValueError(
+            "To access the WindBorne API, set your Client ID and API key by setting the environment variables WB_CLIENT_ID and WB_API_KEY. "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction. "
+            "To get an API key, email data@windbornesystems.com."
+        )
 
     if not client_id:
-        print("To access the WindBorne API, you need to set your Client ID by setting the environment variable WB_CLIENT_ID.")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print("To get an API key, email data@windbornesystems.com.")
-        exit(90)
+        raise ValueError(
+            "To access the WindBorne API, you need to set your Client ID by setting the environment variable WB_CLIENT_ID. "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction. "
+            "To get an API key, email data@windbornesystems.com."
+        )
 
     if not api_key:
-        print("To access the WindBorne API, you need to set your API key by setting the environment variable WB_API_KEY.")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print("To get an API key, email data@windbornesystems.com.")
-        exit(91)
+        raise ValueError(
+            "To access the WindBorne API, you need to set your API key by setting the environment variable WB_API_KEY. "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction. "
+            "To get an API key, email data@windbornesystems.com."
+        )
 
     if len(client_id) in [32, 35] and len(api_key) not in [32, 35]:
-        print("Your Client ID and API Key are likely swapped.")
-        print("--------------------------------------")
-        print("Swap them or modify them accordingly to get access to WindBorne API.")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print(f"Current Client ID: {client_id}")
-        print(f"Current API Key: {api_key}")
-        exit(95)
+        raise ValueError(
+            f"Your Client ID and API Key are likely swapped. Current Client ID: {client_id}, Current API Key: {api_key}. "
+            "Swap them or modify them accordingly to get access to WindBorne API. "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction."
+        )
 
     # Validate WB_CLIENT_ID format
     if is_valid_uuid_v4(client_id):
-        print("Personal API tokens are not yet supported.")
-        print("--------------------------------------")
-        print("You will need to get a globally-authorizing API key.")
-        print("For questions, email data@windbornesystems.com.")
-        exit(1)
+        raise NotImplementedError(
+            "Personal API tokens are not yet supported. "
+            "You will need to get a globally-authorizing API key. "
+            "For questions, email data@windbornesystems.com."
+        )
 
     if not (is_valid_uuid_v4(client_id) or is_valid_client_id_format(client_id)):
-        print("Your Client ID is misformatted.")
-        print("--------------------------------------")
-        print("It should either be a valid UUID v4 or consist of only lowercase letters, digits, and underscores ([a-z0-9_]).")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print(f"Current Client ID: {client_id}")
-        exit(92)
+        raise ValueError(
+            f"Your Client ID is misformatted: {client_id}. "
+            "It should either be a valid UUID v4 or consist of only lowercase letters, digits, and underscores ([a-z0-9_]). "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction."
+        )
 
     # Validate WB_API_KEY for both newer and older formats
     if api_key.startswith("wb_"):
         if len(api_key) != 35:
-            print("Your API key is misformatted.")
-            print("--------------------------------------")
-            print("API keys starting with 'wb_' must be 35 characters long (including the 'wb_' prefix).")
-            print("--------------------------------------")
-            print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-                  "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-                  "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-                  "for instruction on how to set your credentials for code usage.")
-            print("--------------------------------------")
-            print(f"Current API key: {api_key}")
-            exit(93)
+            raise ValueError(
+                f"Your API key is misformatted: {api_key}. "
+                "API keys starting with 'wb_' must be 35 characters long (including the 'wb_' prefix). "
+                "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction."
+            )
     elif len(api_key) != 32:  # For early tokens
-        print("Your API key is misformatted.")
-        print("--------------------------------------")
-        print("API keys created in 2023 or earlier must be exactly 32 characters long.")
-        print("--------------------------------------")
-        print("You may refer to https://windbornesystems.com/docs/api/cli#introduction\n"
-              "for instructions on how to set your credentials as environment variables for CLI and Code usage\n\n"
-              "and to https://windbornesystems.com/docs/api/pip_data#introduction\n"
-              "for instruction on how to set your credentials for code usage.")
-        print("--------------------------------------")
-        print(f"Current API key: {api_key}")
-        exit(94)
+        raise ValueError(
+            f"Your API key is misformatted: {api_key}. "
+            "API keys created in 2023 or earlier must be exactly 32 characters long. "
+            "For instructions, refer to https://windbornesystems.com/docs/api/cli#introduction or https://windbornesystems.com/docs/api/pip_data#introduction."
+        )
 
 
 VERIFIED_WB_CLIENT_ID = None
@@ -143,8 +106,7 @@ def make_api_request(url, params=None, as_json=True, retry_counter=0):
     :return:
     """
     if retry_counter >= 5:
-        print("Max retries to API reached. Exiting.")
-        exit(1)
+        raise ConnectionError("Max retries to API reached.")
 
     client_id, api_key = get_verified_api_credentials()
 
@@ -209,12 +171,8 @@ def make_api_request(url, params=None, as_json=True, retry_counter=0):
             time.sleep(2**retry_counter)
             return make_api_request(url, params, as_json, retry_counter + 1)
         else:
-            print(f"Unrecoverable HTTP error occurred \n\n{http_err}")
-            if params:
-                print("\nParameters provided:")
-                for key, value in params.items():
-                    print(f"  {key}: {value}")
-            exit(1)
+            # Re-raise the HTTP error instead of exiting
+            raise http_err
     except requests.exceptions.ConnectionError as conn_err:
         print(f"Temporary connection failure; sleeping for {2**retry_counter}s before retrying")
         print(f"Underlying error: \n\n{conn_err}")

windborne/cli.py

@@ -20,6 +20,7 @@ from . import (
     get_point_forecasts,
     get_initialization_times,
     get_forecast_hours,
+    get_generation_times,
     get_full_gridded_forecast,
     get_gridded_forecast,
     get_tropical_cyclones
@@ -235,6 +236,11 @@ def main():
     forecast_hours_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
     forecast_hours_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
 
+    # Output Creation Times Command
+    output_creation_times_parser = subparsers.add_parser('generation_times', help='Get the time at which each forecast hour output file was generated')
+    output_creation_times_parser.add_argument('-i', '--intracycle', action='store_true', help='Use the intracycle forecast')
+    output_creation_times_parser.add_argument('-e', '--ens-member', help='Ensemble member (eg 1 or mean)')
+
     args = parser.parse_args()
 
     ####################################################################################################################
@@ -437,6 +443,9 @@ def main():
     elif args.command == 'forecast_hours':
         get_forecast_hours(print_response=True, ensemble_member=args.ens_member, intracycle=args.intracycle)
 
+    elif args.command == 'generation_times':
+        get_generation_times(print_response=True, ensemble_member=args.ens_member, intracycle=args.intracycle)
+
     elif args.command == 'gridded':
         if len(args.args) in [0,1,2]:
             print(f"To get the gridded forecast for a variable you need to provide the variable, time, and an output file.")

windborne/forecasts_api.py

@@ -324,6 +324,29 @@ def get_forecast_hours(print_response=False, ensemble_member=None, intracycle=Fa
     return response
 
 
+def get_generation_times(print_response=False, ensemble_member=None, intracycle=False):
+    """
+    Get the creation time for each forecast hour output file.
+
+    Returns dict with keys of initialization times and values of dicts, each of which has keys of forecast hours and values of creation times (as ISO strings)
+    """
+
+    params = {
+        'ens_member': ensemble_member,
+        'intracycle': intracycle
+    }
+    response = make_api_request(f"{FORECASTS_API_BASE_URL}/generation_times.json", params=params)
+
+    if print_response:
+        print("Generation times:")
+        for time, hours in response.items():
+            print(f" - {time}:")
+            for hour, creation_time in hours.items():
+                print(f"   - {hour}: {creation_time}")
+
+    return response
+
+
 # Tropical cyclones
 def print_tc_supported_formats():
     """Print supported file formats for saving tcs data."""

{windborne-1.2.1.dist-info → windborne-1.2.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: windborne
-Version: 1.2.1
+Version: 1.2.4
 Summary: A Python library for interacting with WindBorne Data and Forecasts API
 Author-email: WindBorne Systems <data@windbornesystems.com>
 Classifier: Programming Language :: Python :: 3
@@ -29,3 +29,5 @@ Run `windborne --help` for more information.
 
 ## Further information and help request
 If you encounter issues or have questions, please ask your WindBorne Systems contact or email data@windbornesystems.com.
+
+For development of this package, see [README_dev.md](README_dev.md)

windborne-1.2.4.dist-info/RECORD

@@ -0,0 +1,13 @@
+windborne/__init__.py,sha256=dslI8_5Wozr96w7c0E7_HEpYIHt9YaTLo3ADF2yapSk,2102
+windborne/api_request.py,sha256=moFKZFKMrHCINtve6ZfQYgrGgd6tXQffVGuNkZzprV4,8508
+windborne/cli.py,sha256=TzEZtfzOgMgPU11ARgJ6O3YZFV3TcXPPYOabHBKb01Y,29247
+windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
+windborne/forecasts_api.py,sha256=mg7rJkBUE9xSyKIx4RMN0-RIZBdqqSz7Jp5JqFg8DhI,17053
+windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
+windborne/track_formatting.py,sha256=LaLfTyjpWoOtHmReJPLViY0MKm_iPL_5I2OB_lNvGGA,10054
+windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
+windborne-1.2.4.dist-info/METADATA,sha256=IueZfHUEH8-ZAqiUm-pODRED1uRRsRKfecGq7lokM8E,1304
+windborne-1.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+windborne-1.2.4.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
+windborne-1.2.4.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
+windborne-1.2.4.dist-info/RECORD,,

{windborne-1.2.1.dist-info → windborne-1.2.4.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.7.1)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

windborne-1.2.1.dist-info/RECORD

@@ -1,13 +0,0 @@
-windborne/__init__.py,sha256=nRvcreJarSKLwx40adsZSbYm-pc3htE2HZJvgY0MQUA,2044
-windborne/api_request.py,sha256=wh8-LANzB62eJt699Zk3YHv4pIzwa1DIhiTJdWRp-To,11264
-windborne/cli.py,sha256=Y0oLQLqHAhGX1xCM4vpREpGAMhECM4SK87h2DkUjalU,28643
-windborne/data_api.py,sha256=sYZkcQog8RuLErfdLLa4gC8fRkAoPGNKKQJ8i6o-LTQ,33826
-windborne/forecasts_api.py,sha256=tp0tirS91xBwv9CuScJwjNiiVhrV3fHL6U5UxAdWLXk,16266
-windborne/observation_formatting.py,sha256=c739aaun6aaYhXl5VI-SRGR-TDS355_0Bfu1t6McoiM,14993
-windborne/track_formatting.py,sha256=LaLfTyjpWoOtHmReJPLViY0MKm_iPL_5I2OB_lNvGGA,10054
-windborne/utils.py,sha256=H8gvZ4Lrr0UmLl25iMZs6NsZliCY_73Ved_rBIqxJg4,7240
-windborne-1.2.1.dist-info/METADATA,sha256=jKnNK7Ar8N3mn9Ab1ptcim8rTX-gPD6L5w6tG_nhIzM,1235
-windborne-1.2.1.dist-info/WHEEL,sha256=Nw36Djuh_5VDukK0H78QzOX-_FQEo6V37m3nkm96gtU,91
-windborne-1.2.1.dist-info/entry_points.txt,sha256=j_YrqdCDrCd7p5MIwQ2BYwNXEi95VNANzLRJmcXEg1U,49
-windborne-1.2.1.dist-info/top_level.txt,sha256=PE9Lauriu5S5REf7JKhXprufZ_V5RiZ_TnfnrLGJrmE,10
-windborne-1.2.1.dist-info/RECORD,,