Metadata-Version: 2.4
Name: novastar-client
Version: 1.2.0
Summary: Python client for NovaStar REST endpoints (Stations)
Author: Jeff Gregory
Author-email: Jeff Gregory <jeffrey.s.gregory@usace.army.mil>
License-Expression: MIT
Requires-Dist: requests>=2.31.0
Requires-Dist: click
Requires-Dist: pandas
Requires-Dist: hecdss
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# Panama Canal Authority NovaStar API Client, novastar_client

## novastar_client

A Python client library for working with the NovaStar API, with documentation published via pdoc on GitHub pages.  See [Releases](https://github.com/jeffsuperglide/novastar_client/releases) and the latest release for this package details and install guidance.

## Overview

`novastar_client` is meant for developers who want to control or integrate NovaStar workflows from Python code instead of relying entirely on desktop tools.  The documentation site is structured as API reference material, so the package is best approached as importable library for scripts, services, and internal utilities.

## What it includes

- A Python package under the `novastar_client` name, documented with pdoc.
- An API-first layout intended for code-based usage.
- Published release artifacts for installation from GitHub release pages.

## Installation

Install from the repository's [Releases](https://github.com/jeffsuperglide/novastar_client/releases) using the package file provided on the GitHub release page.  Release assets include a tarball and wheel.  Download to install with pip, or install directly from the release version.  It is suggested to use the wheel for installation because it will be a quicker install.

### pip install wheel, Windows CMD

```cmd
pip install .\novastar_client-0.1.0-py3-none-any.whl
```

### pip install tarball, Windows CMD

```cmd
pip install .\novastar_client-0.1.0.tar.gz
```

### Direct pip install whl, Windows CMD

```cmd
pip install "https://github.com/jeffsuperglide/novastar_client/releases/download/v0.1.0/novastar_client-0.1.0-py3-none-any.whl"
```

## Documentation

The full API reference is published at https://jeffsuperglide.github.io/novastar_client/.  Reference for:

- Module and class names.
- Method signatures.
- Parmeter details.
- Return values.

## Reference Links

[API-UI](https://panama-cloud-ns5.trilynx-novastar.systems/novastar/data/api/v1/api-ui)

[Operator Manual](https://panama-cloud-ns5.trilynx-novastar.systems/novastar/doc/operator/user/)

[Operator Map](https://panama-cloud-ns5.trilynx-novastar.systems/novastar/operator/map)

[Stations API Call - Simple](https://panama-cloud-ns5.trilynx-novastar.systems/novastar/data/api/v1/stations)

[TriLynx NovaStar Web Services Docs Home](https://software.trilynx.systems/nsdataws/latest/doc-user/).

[Jython.org](https://www.jython.org/)

[Python 2.7](https://docs.python.org/2.7/)
