Metadata-Version: 2.1
Name: orbitalcyber-sdk
Version: 0.1.2
Summary: This package provides an SDK that can be used to jumpstart projects that interact with the OrbitalCyber API
Home-page: https://github.com/Sage-Infrastructure-Solutions-Group-Inc/orbitalcyber-python-sdk
Author: Rylan Merritt
Author-email: rmerritt@sageisg.com
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests

# OrbitalCyber Python SDK
This repository contains the OrbitalCyber SDK, examples, and API documentation.

## Introduction
The OrbitalCyber SDK is a production-ready python module that can be used to interact with the OrbitalCyber REST API.

## Installation
There are two options you may use to install the SDK. 
> The following instructions assume you have installed the necessary prerequisites, such as Python3, pip, and, if applicable, git.
### PyPi
To install the SDK from PyPi please run the commands below.
```bash
python3 -m pip install orbitalcyber-sdk
```
### GitHub
To install the SDK using git and the GitHub repository please use the following commands:
```bash
git clone https://github.com/Sage-Infrastructure-Solutions-Group-Inc/orbitalcyber-python-sdk.git
cd orbitalcyber-python-sdk
python3 setup.py install
```
## Examples
Our team has provided quick examples of how to interact with the API in the [examples folder](https://github.com/Sage-Infrastructure-Solutions-Group-Inc/orbitalcyber-python-sdk/tree/main/examples) within the GitHub repository.
## Additional Help and Documentation
Detailed API documentation can be found in the [API Documentation](https://orbitalcyber.com/index.php/docs-category/api_docs/) section of the OrbitalCyber knowledge base.
