Metadata-Version: 2.4
Name: eratos-sdk
Version: 0.16.0
Summary: Python SDK for interacting with Eratos platform and services
Project-URL: Homepage, https://eratos.com
Author-email: Eratos <support@eratos.com>
Maintainer-email: Eratos <support@eratos.com>
License-File: LICENSE
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Requires-Dist: deepmerge>=0.1.0
Requires-Dist: h5py>=3.0.0
Requires-Dist: netcdf4>=1.5.0
Requires-Dist: numpy>=1.18.0
Requires-Dist: pandas>=1.3.0
Requires-Dist: pyjwt>=2.3.0
Requires-Dist: pyproj>=3.0.1
Requires-Dist: pyyaml>=5.4.1
Requires-Dist: requests-toolbelt>=1.0.0
Requires-Dist: requests>=2.27.0
Requires-Dist: shapely>=1.8.1
Requires-Dist: tabulate>=0.8.9
Requires-Dist: urllib3>=1.26.0
Provides-Extra: dev
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: python-dotenv; extra == 'dev'
Requires-Dist: responses; extra == 'dev'
Requires-Dist: sphinx; extra == 'dev'
Requires-Dist: xarray; extra == 'dev'
Provides-Extra: full
Requires-Dist: eratos-as-api; extra == 'full'
Requires-Dist: eratos-as-client; extra == 'full'
Requires-Dist: eratos-sensor; extra == 'full'
Requires-Dist: eratos-tdm; extra == 'full'
Requires-Dist: eratos-tds; extra == 'full'
Requires-Dist: eratos-xarray; extra == 'full'
Description-Content-Type: text/markdown

# Python SDK to interact with the Eratos Platform.
Copyright (c) Eratos Group Pty Ltd 2019-2025.

## Installation

Run the following to bring in the package dependencies and the SDK package.

```shell
pip install .
```

If you wish to develop locally, please install with the following command instead.

> Note: Use the `[-e/--editable]` flag to symlink local changes to the installed package.

```shell
pip install .[dev]
```

If you are using zsh...

```shell
pip install '.[dev]'
```

If you wish to make wheel or sdist build you can do so with the following with the hatchling backend:
```shell
hatch build
```

## Tests

To run tests make sure you have the `dev` dependencies installed and run the following:

```shell
pytest tests/
```

`pytest` will run both the legacy `python.unittest` tests as well as the new `pytest` tests but not the other way so using `pytest` is preferred onwards from now.
The choice to adopt `pytest` has been made to make use of test fixtures to speed up development of future tests.
See [latest pytest api reference](https://docs.pytest.org/en/latest/reference/reference.html) for more info or the [getting started docs](https://docs.pytest.org/en/latest/getting-started.html).

### Integration tests

Integration tests in `tests/test_add_objects.py` will be skipped if the environment variables `ERATOS_ID` and `ERATOS_SECRET` are unset.
Add these API key values in a `.env` file in the root of the project or export as an environment variable to run the tests.

