Metadata-Version: 2.1
Name: pysurfline
Version: 0.0.2
Summary: python client to Surfline API
Home-page: https://github.com/giocaizzi/pysurfline
Author: giocaizzi
Author-email: giocaizzi@gmail.com
License: MIT
Project-URL: Documentation, https://giocaizzi.github.io/pysurfline/
Project-URL: Bug Reports, https://github.com/giocaizzi/pysurfline/issues
Project-URL: Source, https://github.com/giocaizzi/pysurfline
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Provides-Extra: docs
Provides-Extra: dev

# pysurfline

Python wrapper of Surfline V2 API.

`pysurfline` features:
- getting Surfline forecast for any spot that is listed on [Surfline](https://www.surfline.com)(surf, swell, wind, tides, daylight info)
- produce structured surf reports.

# Installation

Install with `pip`
```
pip install pysurfline
```

# Example

Get the `pysurfline.SurfReport` plot for Banzai Pipeline in Oahu, Hawaii (USA).

![SurfReport plot](https://github.com/giocaizzi/pysurfline/blob/main/docsrc/source/images/surfreport_pipeline.jpeg)

# Documentation

The documentation can be found [here](https://giocaizzi.github.io/pysurfline/).


