Metadata-Version: 2.1
Name: nautical
Version: 3.0.1
Summary: The nautical package provides users with access to historical and real time nautical information.
Home-page: https://github.com/barbacbd/nautical
Author: Brent Barbachem
Author-email: barbacbd@dukes.jmu.edu
Maintainer: Brent Barbachem
Maintainer-email: barbacbd@dukes.jmu.edu
License: MIT
Keywords: nautical,noaa,ncei,ocean,water
Classifier: Programming Language :: Python :: 3
Requires-Python: <4,>=3.6
Description-Content-Type: text/markdown

<h1 align="center">
  <a href="https://github.com/barbacbd/nautical">
    <img src="https://github.com/barbacbd/nautical/blob/231d553500087cf23348aa80b830cf842f9edd1e/.images/buoy.jpg" width="256" height="256" border-radius="50%" >
  </a>
  <br>Nautical</br>
</h1>

<h2 align="center">
  
![build workflow](https://github.com/barbacbd/nautical/actions/workflows/python-app.yml/badge.svg) [![PyPI version fury.io](https://badge.fury.io/py/nautical.svg)](https://pypi.python.org/pypi/nautical/) [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/barbacbd/nautical/pulse/commit-activity) [![GitHub latest commit](https://badgen.net/github/last-commit/barbacbd/nautical)](https://github.com/barbacbd/nautical/commit/)

[![Linux](https://svgshare.com/i/Zhy.svg)](https://svgshare.com/i/Zhy.svg) [![macOS](https://svgshare.com/i/ZjP.svg)](https://svgshare.com/i/ZjP.svg) [![Windows](https://svgshare.com/i/ZhY.svg)](https://svgshare.com/i/ZhY.svg)
</h2>

# Description

Ahoy! Whether you've got your sea legs under yeh', or you're just looking to get those toes wet, you have discovered Nautical. Nautical contains an extension to a python based web scraper that
allows users to retrieve [NOAA](https://www.ndbc.noaa.gov/) buoy information. Nautical also provides users with a simple interface to the [NOAA NCEI](https://www.ncei.noaa.gov/) web api.

Peer into that spyglass and review the [nautical documentation](https://barbacbd.github.io/nautical/build/html/index.html) for more information.


# Documentation

View the [documentation](user/docs/Documentation.md) page for more information.

# Contributing

View the [contirbution](user/docs/Contributing.md) for more information.

# Examples

More details and specific examples can be found in [here](user/docs). 

# Building and Testing

## Create the environment [optional]

If you wish to create a virtual environment:

```
python -m venv /path/to/nautical_venv
```

**NOTE:** The `python` referenced above should be a version of python that is acceptable for this library.

Don't forget to activate the virtual environment, `source /path/to/nautical_venv/bin/activate`.

## Install dependencies

**NOTE:** The dependencies will be installed in the next step, but provides the opportunity to view
the dependency install by itself.

```
pip install pip --upgrade;

pip install -r requirements.txt
```

## Install the package

```
pip install . --upgrade
```

## Execute Tests

If you wish to view the results with a bit more information, run the following commmand:

```
pip install pytest coverage pytest-cov mock
```

All tests for the project are located in the [tests](./tests)  directory.
The minimal requirements for the contributions to make it into the repository will be to pass all tests.
Run the `pytest` command in this directory, or provide the directory to the
command. Use the `coverage and pytest-cov` packages to view all of the results more clearly.

```
pytest --cov=tests
```

If the user is running a system that can execute shell scripts, run the following from the project base directory:

```bash
scripts/pytest.sh
```

The user may also view the output of linting with:

```bash
scripts/pylint.sh
```
