ocean-leonid 0.1.0

No project description provided

README

This is a project written by Robert Lawrence for the purposes of the Ocean Leonid assessment.

Distribution

Github

To get started with the raw code, clone the repo and then run the following commands:

pip install poetry
poetry install
python main.py

The dash app is now available on your browser at http://localhost:8050.

Docker

To deploy the dash app using docker use the following commands:

docker build . -t ocean_leonid
docker container run -p 8050:8050  ocean_leonid

The dash app is now available on your browser at http://localhost:8050.

Pip package

I havent been able to create a PyPi account. But if I had then all that would need to be done is configure the credentials and then:

poetry build
poetry publish

Then to use the package:

pip install ocean_leonid

from ocean_leonid import show_viz

show_viz()

Tests

The testing is done using pytest

The configuration is in pyproject.toml.

To run the tests use:

pytest

External Dependencies

The external dependencies of this solution are the 2 API's that are called to get the data for the graph.