Metadata-Version: 2.4
Name: okapi-aether-sdk
Version: 1.0.1
Summary: Python SDK for the OKAPI:Aether API
Keywords: space,space debris,aether,space traffic coordination,okapi orbits,sdk,REST API
Author-email: "OKAPI:Orbits" <contact@okapiorbits.space>
Requires-Python: >= 3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Intended Audience :: Developers
Classifier: Topic :: Utilities
License-File: LICENSE
Requires-Dist: python-dotenv
Requires-Dist: requests
Requires-Dist: pymongo
Requires-Dist: PyJWT
Requires-Dist: click>=8,<9
Requires-Dist: ruff ; extra == "dev"
Requires-Dist: mypy ; extra == "dev"
Requires-Dist: types-requests ; extra == "dev"
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pytest-env ; extra == "dev"
Requires-Dist: pytest-html ; extra == "dev"
Requires-Dist: bandit ; extra == "dev"
Requires-Dist: testcontainers ; extra == "dev"
Requires-Dist: black ; extra == "dev"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx-book-theme ; extra == "docs"
Requires-Dist: myst-parser ; extra == "docs"
Requires-Dist: sphinx-autoapi ; extra == "docs"
Requires-Dist: sphinx-click ; extra == "docs"
Requires-Dist: myst-nb ; extra == "docs"
Project-URL: Homepage, https://www.okapiorbits.space
Provides-Extra: dev
Provides-Extra: docs

# Python SDK for OKAPI:Aether

This is a lightweight Python SDK to access the public OKAPI:Aether API.

## Installation

The SDK is easy to install using `pip`. We recommend creating a virtual environment for the project.

```
python3 -m venv .venv
source .venv/bin/activate
pip install okapi-aether-sdk
```

## Configuration
Authentication to OKAPI:Aether is performed via the following ENV variables (they can be set directly or via an `.env` file):
* `AETHER_AUTH0_USERNAME`
* `AETHER_AUTH0_PASSWORD`

The use of the env variables can be overriden by directly passing the appropriate username and password to the `login` method.

## Functionality

It allows for easy access to CDMs, fleet management, upload of ephemerides and maneuver plans, etc.

For more details, please consult the respective section in the OKAPI:Aether user manual.

### CLI
The okapi-aether-sdk comes with a command line interface. See the help command for additional usage information.

```
aether-api --help
```

