Skip to content

unaisshemim/nautical

 
 

Repository files navigation


Nautical

build workflow PyPI version fury.io Maintenance GitHub latest commit

Linux macOS Windows

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 buoy information. Nautical also provides users with a simple interface to the NOAA NCEI web api.

Peer into that spyglass and review the nautical documentation for more information.

Documentation

View the documentation page for more information.

Contributing

View the contirbution for more information.

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 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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%