Skip to content

Mircobrb/pysurfline

 
 

Repository files navigation

pysurfline

Get the surf forecast for any spot listed on Surfline.

Quickly get the forecast data as a pandas Dataframe and plot surf forecast with matplotlib to visualize the conditions of your favorite surf spot.

  • Surf (surf min, surf max)
  • Wind (speed, direction)
  • Swell (height, period, direction)
  • Tide (height, direction)
  • Daylight (sunrise, sunset)
Distribution PyPI PyPI - Python Version
Tests Tests codecov
Code black flake8
Documentation Documentation build

Installation

Install with pip

pip install pysurfline

Example

  • Get the surf forecasts for a given SpotId and get data as a pandas Dataframe.

    Go to full example.

    import pysurfline
    
    spotId = "5842041f4e65fad6a7708cfd"
    
    spotforecasts = pysurfline.get_spot_forecasts(spotId)
    
    df = spotforecasts.get_dataframe()
  • Visualize the surf report for a given SpotId.

    Go to full example.

    import pysurfline
    
    spotId = "5842041f4e65fad6a7708cfd"
    
    spotforecasts = pysurfline.get_spot_forecasts(spotId)
    
    pysurfline.plot_surf_report(
        spotforecasts,
        barLabels = True,
        )

SurfReport plot

Documentation

The documentation can be found here.

Disclaimer

This package is not official and not affiliated with Surfline in any way.

API responses may change at any time and the developement of this package may not be able to keep up with those changes.

If you find any issues, please open an issue or submit a pull request.

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%