Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nbering/hydroserver

Command line client for the Niagara Peninsula Conservation Authority's watercourse data web service.
https://github.com/nbering/hydroserver

Last synced: about 2 months ago
JSON representation

Command line client for the Niagara Peninsula Conservation Authority's watercourse data web service.

Host: GitHub
URL: https://github.com/nbering/hydroserver
Owner: nbering
License: mit
Created: 2016-09-04T19:27:05.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2016-09-05T13:41:03.000Z (over 8 years ago)
Last Synced: 2024-10-12T08:11:43.027Z (3 months ago)
Language: JavaScript
Size: 19.5 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# HydroServer CLI

[![npm (scoped)](https://img.shields.io/npm/v/@nbering/hydroserver.svg?maxAge=2592000?style=plastic)](https://www.npmjs.com/package/@nbering/hydroserver/)
[![GitHub issues](https://img.shields.io/github/issues/nbering/hydroserver.svg?maxAge=2592000?style=plastic)](https://github.com/nbering/hydroserver/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/nbering/hydroserver.svg?maxAge=2592000?style=plastic)](https://github.com/nbering/hydroserver/pulls)

## What is this?

A simple tool for interacting with the [CUAHSI](https://github.com/CUAHSI) WaterOneFlow
Web Service included in their HydroServer project. I specifically build this to
fetch data from the HydroServer run by the [Niagara Peninsula Conversation Authority](npca.ca).

## Is it finished?

Not even close. At this point the tool is just a proof of concept. I'll be working
a little more on it to make it more functional and add documentation.

## Instructions

### Install

You'll need NodeJS and NPM. Developed and tested on NodeJS v6.5.0.

```
$ npm install --global @nbering/hydroserver
```

### Usage

For basic usage instructions, run:

```
$ hydroserver help
```

### Common Commands

```sh
# List Monitoring Sites
$ hydroserver sites

# Show Details About a Site
$ hydroserver site --site NPCA:BALLS_FALLS

# Get Some Data Points
$ hydroserver values \
--start-date 2010-01-01T00:00:00 \
--end-date 2010-01-31T23:59:59 \
--variable NPCA:FLOW \
--site NPCA:BALLS_FALLS
```

## Contributing

The project's a bit of a mess right now but I welcome issues for feature suggestions,
use case descriptions, bug reports, or support requests.

Pull Requests may or may not be accepted depending on content. Please ask first
before writing significant amounts of code so that I can give some guidance based
on my plans for the project. Thank you!

## License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.