earthscope-sdk 1.0.0b1__py3-none-any.whl → 1.2.0b0__py3-none-any.whl

earthscope_sdk/util/_time.py

@@ -0,0 +1,57 @@
+import datetime as dt
+from datetime import timezone
+from typing import NamedTuple, TypeVar
+
+T = TypeVar("T")
+
+
+class TimePeriod(NamedTuple):
+    """
+    A time period.
+
+    Attributes:
+        start (datetime): Start datetime.
+        end (datetime): End datetime.
+    """
+
+    start: dt.datetime
+    end: dt.datetime
+
+    def __str__(self):
+        return repr(self)
+
+    def __repr__(self):
+        return f"[{self.start}, {self.end})"
+
+    @property
+    def duration(self) -> dt.timedelta:
+        return self.end - self.start
+
+
+def time_range_periods(start: dt.datetime, end: dt.datetime, period: dt.timedelta):
+    """
+    Generate time ranges between start and end broken into periods of size 'period'.
+
+    Args:
+        start (datetime): Start datetime.
+        end (datetime): End datetime.
+        period (timedelta): Size of each time period.
+
+    Yields:
+        TimePeriod: Start and end of each period.
+    """
+    current = start
+    while current < end:
+        next_time = min(current + period, end)
+        yield TimePeriod(start=current, end=next_time)
+        current = next_time
+
+
+def to_utc_dt(dt: dt.datetime) -> dt.datetime:
+    """
+    Convert a datetime to an aware datetime in the UTC timezone.
+    """
+    if dt.tzinfo is None:
+        return dt.replace(tzinfo=timezone.utc)
+
+    return dt.astimezone(timezone.utc)

earthscope_sdk/util/_types.py

@@ -0,0 +1,5 @@
+from typing import TypeVar, Union
+
+T = TypeVar("T")
+
+ListOrItem = Union[list[T], T]

{earthscope_sdk-1.0.0b1.dist-info → earthscope_sdk-1.2.0b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: earthscope-sdk
-Version: 1.0.0b1
+Version: 1.2.0b0
 Summary: An SDK for EarthScope API
 Author-email: EarthScope <data-help@earthscope.org>
 License:                                  Apache License
@@ -216,12 +216,16 @@ License-File: LICENSE
 Requires-Dist: httpx>=0.27.0
 Requires-Dist: pydantic-settings[toml]>=2.8.0
 Requires-Dist: stamina>=24.3.0
+Provides-Extra: arrow
+Requires-Dist: pyarrow>=20.0.0; extra == "arrow"
+Requires-Dist: pyarrow-stubs>=20.0.0; extra == "arrow"
 Provides-Extra: dev
 Requires-Dist: bumpver; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: twine; extra == "dev"
 Requires-Dist: pip-tools; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest-httpx; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: ruff; extra == "dev"
@@ -241,9 +245,16 @@ Install from PyPI
 pip install earthscope-sdk
 ```
 
+Or with optional dependencies:
+
+```shell
+# install arrow dependencies for efficient data access
+pip install earthscope-sdk[arrow]
+```
+
 ### Usage
 
-For detailed usage options and examples, visit [our usage docs](docs/usage.md).
+For detailed usage info and examples, visit [our SDK docs](https://docs.earthscope.org/projects/SDK).
 
 ```py
 # Import and create a client
@@ -300,7 +311,7 @@ Once refreshable credentials are available to the SDK, it will transparently han
 
 ### Same host
 
-If you have the [EarthScope CLI](TODO) installed on the same host that is running your application which uses `earthscope-sdk`, you can simply log in using the CLI. The CLI shares credentials and configuration with this SDK (when running on the same host).
+If you have the [EarthScope CLI](https://docs.earthscope.org/projects/CLI) installed on the same host that is running your application which uses `earthscope-sdk`, you can simply log in using the CLI. The CLI shares credentials and configuration with this SDK (when running on the same host).
 
 Running `es login` will open your browser and prompt you to log in to your EarthScope account.
 
@@ -320,7 +331,7 @@ Now when you run your application, `earthscope-sdk` will find your credentials.
 
 Sometimes your workload runs on different hosts than your main workstation and you cannot feasibly "log in" on all of them. For example, maybe you're running many containers in your workload.
 
-You can still use the [EarthScope CLI](TODO) to facilitate auth for applications on other machines.
+You can still use the [EarthScope CLI](https://docs.earthscope.org/projects/CLI) to facilitate auth for applications on other machines.
 
 1. Use the CLI on your primary workstation [as described above](#same-host) to log in.
 

earthscope_sdk-1.2.0b0.dist-info/RECORD

@@ -0,0 +1,49 @@
+earthscope_sdk/__init__.py,sha256=tHAIgbIAiK4xpxSusvWASwptTKQIk73KWaOlem5uR7A,156
+earthscope_sdk/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/auth/auth_flow.py,sha256=gxJmCr5TAhMEss7RskYFCv6-D3A5h0Zw2ejeLJJ_9aI,10352
+earthscope_sdk/auth/client_credentials_flow.py,sha256=GAvskuoEd6qHe-BtfGwYQisMedmSkDhagy4aRPVPri4,2494
+earthscope_sdk/auth/device_code_flow.py,sha256=p53pgRQraToFwONPBj3O3DHAa4x4rE6rvygo_Bbj5_U,8394
+earthscope_sdk/auth/error.py,sha256=eC33Bw1HaBEJE7-eI2krtE__5PxStc3EyiYO12v0kVw,693
+earthscope_sdk/client/__init__.py,sha256=JotTr5oTiiOsUc0RTg82EVCUSg_-u80Qu_R0-crCXkY,139
+earthscope_sdk/client/_client.py,sha256=g-3HSOFioeKPzsO4bcgoWhH5hCSs3TzPR3JegAsOh5I,2038
+earthscope_sdk/client/data_access/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/client/data_access/_base.py,sha256=3ZG5KERhFbGO1vNUWgj-NP490WFR4g76jmM0MTShb8w,2547
+earthscope_sdk/client/data_access/_service.py,sha256=Po25WryLgYfcg87NR89r5VSgSXKnprngXywCKUGa6S0,3978
+earthscope_sdk/client/data_access/_arrow/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/client/data_access/_arrow/_common.py,sha256=OhlU6uUR0kDgaHyAfV075JyWwUGSs9iQfqpsa8yE0lM,2590
+earthscope_sdk/client/data_access/_arrow/_gnss.py,sha256=sw4TtTMiJJJgokMlT8d7bs5pf5V64Oh4FhOJ0JJGhq0,3135
+earthscope_sdk/client/data_access/_query_plan/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/client/data_access/_query_plan/_gnss_observations.py,sha256=NEtwUiUc46V84sRZltbSMptIjiyjHNjB3Xxo0LJbmPM,8915
+earthscope_sdk/client/data_access/_query_plan/_query_plan.py,sha256=kZDaYwmUeihO5wPKJPp62gBr4R8xO6A5XVa2w5djRiw,7862
+earthscope_sdk/client/data_access/_query_plan/_request_set.py,sha256=pwdZW_-i2Mm9UdzS9bjXMBoq7YobRRAuuDLAFurXoT8,3777
+earthscope_sdk/client/discovery/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/client/discovery/_base.py,sha256=kFtIdu8_kHdLEqVd_RL1f8ND8e0-NZw34w1skgvlVzA,10676
+earthscope_sdk/client/discovery/_service.py,sha256=QEHXW9T7Kupka57hQBJR3qKBppBDU3zdU7M0xkOAMMo,7026
+earthscope_sdk/client/discovery/models.py,sha256=-QsYXMZAO9YM29EYiZhsJ0Bo28UBfVaOgHhPoP2cy6g,3787
+earthscope_sdk/client/user/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/client/user/_base.py,sha256=8dn4pfQMwVDpF0E6dl6P6HJuNVvozUzfgUGefnPXMnw,1076
+earthscope_sdk/client/user/_service.py,sha256=wRktOZF5GXajXXxij3Nkule6wvuWOV0vn4QsA1IXVHc,3063
+earthscope_sdk/client/user/models.py,sha256=drZAMwOYC1NVCzBZQhNL-pPTB28SURKfoZF8HdjlIj8,1214
+earthscope_sdk/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/common/_sync_runner.py,sha256=h_A2pSEjZCLj7ov50M6cWHVoX6eXVmGzz5nX0MwLWDY,4131
+earthscope_sdk/common/client.py,sha256=g5ZTNhFm33H68J9pWD5fDu760Yd5cBdfQmsbU3t8D_4,2156
+earthscope_sdk/common/context.py,sha256=8IyfDDSIjLS6oV2aHkCRNjh5rN4dyXLzuntnhE36UoA,7395
+earthscope_sdk/common/service.py,sha256=G48u-zaGfb4TEq5FaVDTc9LwLnLZPAY1pn8P5uZoJKM,1611
+earthscope_sdk/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/config/_bootstrap.py,sha256=BvDSRccvFPFRnLS4MlE7OMLGYEgxY7znxFZ6AYgxvOE,1243
+earthscope_sdk/config/_compat.py,sha256=P3F5y_Kf5zp9m9uOhl1Bp3ke6expxq4Sm9AeVaBbAHk,4610
+earthscope_sdk/config/_util.py,sha256=RZ6zvKrvjUkO7i69s7AVoIDhamRg4x71CAZLnucr9QM,1249
+earthscope_sdk/config/error.py,sha256=jh25q-b317lAvp32WwQw0zdYoV-MxZtg-n5FgZOMymI,95
+earthscope_sdk/config/models.py,sha256=Gm-KfWnDwDt6n50pTebjEN_ffGS6k4BBYXLL0HCFt6I,9088
+earthscope_sdk/config/settings.py,sha256=kGsoqAgoUS2xrI0rvdqbLEsI2M0Mpbm73oEDLpJG4_Q,9205
+earthscope_sdk/model/secret.py,sha256=QTyWCqXvf9ZYWaVVQcGzdt3rGtyU3sx13AlzkNE3gaU,731
+earthscope_sdk/util/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+earthscope_sdk/util/_concurrency.py,sha256=ryxpwHun91hW2mN9zrsd9J8Q6PsrgkFoYmu3voIGxZI,2056
+earthscope_sdk/util/_itertools.py,sha256=JKUaY05CpEVsXhSuvkZzyEJmm5FjnipbQAfa0BUvxBo,1312
+earthscope_sdk/util/_time.py,sha256=QzsccF951t-FeWvgddj55bpIHsQJJRGxRCPeylVOF1U,1343
+earthscope_sdk/util/_types.py,sha256=FNYmC7u9bgPhWxGOxY8FT2rX6eCuJO5mwbs4y5wJlPA,84
+earthscope_sdk-1.2.0b0.dist-info/licenses/LICENSE,sha256=E_MrVXxRaMQNpvZhsDuz_J9N_ux7dlL_WpYSsE391HU,11349
+earthscope_sdk-1.2.0b0.dist-info/METADATA,sha256=MwXlwToXAjU5vJbR5KP0lTYEu42Jg6yIeFj_BaolWis,18385
+earthscope_sdk-1.2.0b0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+earthscope_sdk-1.2.0b0.dist-info/top_level.txt,sha256=zTtIT9yN3JPJF7TqmTzqQcAvZZe4pAm907DLoGa5T_E,15
+earthscope_sdk-1.2.0b0.dist-info/RECORD,,

{earthscope_sdk-1.0.0b1.dist-info → earthscope_sdk-1.2.0b0.dist-info}/WHEEL

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

earthscope_sdk-1.0.0b1.dist-info/RECORD

@@ -1,28 +0,0 @@
-earthscope_sdk/__init__.py,sha256=GUJAs2cToEo9f8MaCUP_VnRsyqZWNhsN-pId5vzPk4U,156
-earthscope_sdk/auth/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/auth/auth_flow.py,sha256=6jBQxLJ2gAxXGgtZYXDH1yg5L_WUmgu7fRvW4JoCi4Q,10198
-earthscope_sdk/auth/client_credentials_flow.py,sha256=1GyDSIR1OgYP4u0xZoTov1u_YhY1AzHFpOcBCzY1h6E,2769
-earthscope_sdk/auth/device_code_flow.py,sha256=dC5Ffj3HzBguRxSHCZYvTe1MD3C-iKf2AlanGuRKNvI,7922
-earthscope_sdk/auth/error.py,sha256=eC33Bw1HaBEJE7-eI2krtE__5PxStc3EyiYO12v0kVw,693
-earthscope_sdk/client/__init__.py,sha256=JotTr5oTiiOsUc0RTg82EVCUSg_-u80Qu_R0-crCXkY,139
-earthscope_sdk/client/_client.py,sha256=ai7WdsTOYglA6bLkT-Wntvxlke6nSaGHwqrtg5PEy80,833
-earthscope_sdk/client/user/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/client/user/_base.py,sha256=8dn4pfQMwVDpF0E6dl6P6HJuNVvozUzfgUGefnPXMnw,1076
-earthscope_sdk/client/user/_service.py,sha256=wRktOZF5GXajXXxij3Nkule6wvuWOV0vn4QsA1IXVHc,3063
-earthscope_sdk/client/user/models.py,sha256=drZAMwOYC1NVCzBZQhNL-pPTB28SURKfoZF8HdjlIj8,1214
-earthscope_sdk/common/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/common/_sync_runner.py,sha256=h_A2pSEjZCLj7ov50M6cWHVoX6eXVmGzz5nX0MwLWDY,4131
-earthscope_sdk/common/client.py,sha256=g5ZTNhFm33H68J9pWD5fDu760Yd5cBdfQmsbU3t8D_4,2156
-earthscope_sdk/common/context.py,sha256=vrCB_Ez-98Ir7c0GrCe-g7DuRCgc9vPaoRWFYf5q8Ko,5138
-earthscope_sdk/common/service.py,sha256=SCUZVJA3jFaEPeFrOf0v9osf2UpqldhlFmirOYWJjxM,1506
-earthscope_sdk/config/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-earthscope_sdk/config/_compat.py,sha256=P3F5y_Kf5zp9m9uOhl1Bp3ke6expxq4Sm9AeVaBbAHk,4610
-earthscope_sdk/config/_util.py,sha256=RZ6zvKrvjUkO7i69s7AVoIDhamRg4x71CAZLnucr9QM,1249
-earthscope_sdk/config/error.py,sha256=jh25q-b317lAvp32WwQw0zdYoV-MxZtg-n5FgZOMymI,95
-earthscope_sdk/config/models.py,sha256=1334Rxzw4qDLSdQg9btxFQySBOCb8TEW6J95M-lyKEc,8198
-earthscope_sdk/config/settings.py,sha256=I2DwEvfmETcaYbSvUybs0EIih0yiJO9D46WnWzKPqbo,8812
-earthscope_sdk-1.0.0b1.dist-info/licenses/LICENSE,sha256=E_MrVXxRaMQNpvZhsDuz_J9N_ux7dlL_WpYSsE391HU,11349
-earthscope_sdk-1.0.0b1.dist-info/METADATA,sha256=BHeAUzZ882lmEExnoVKIywGSYvIbyNdnIh8BzRJs2Ng,17988
-earthscope_sdk-1.0.0b1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-earthscope_sdk-1.0.0b1.dist-info/top_level.txt,sha256=zTtIT9yN3JPJF7TqmTzqQcAvZZe4pAm907DLoGa5T_E,15
-earthscope_sdk-1.0.0b1.dist-info/RECORD,,