https://github.com/anze3db/surfbot

Your friendly neighborhood surfbot
https://github.com/anze3db/surfbot

Last synced: 7 days ago
JSON representation

Your friendly neighborhood surfbot

• Host: GitHub
• URL: https://github.com/anze3db/surfbot
• Owner: anze3db
• License: mit
• Created: 2017-05-31T17:51:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-15T23:03:09.000Z (over 7 years ago)
• Last Synced: 2024-11-01T04:42:34.234Z (about 2 months ago)
• Language: Python
• Size: 43 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Surf Bot [![CircleCI](https://circleci.com/gh/Smotko/surfbot.svg?style=svg)](https://circleci.com/gh/Smotko/surfbot) [![codecov](https://codecov.io/gh/Smotko/surfbot/branch/master/graph/badge.svg)](https://codecov.io/gh/Smotko/surfbot)

A simple surf bot for retrieving the surf forecast.

You will need to obtain a MSW API key ([more info](http://magicseaweed.com/developer/api)).

## Set up dev env

```

$ virtualenv -p python3 venv

$ . venv/bin/activate

$ pip install awscli flake8 pylint mypy pytest

```

## Run tests

```

$ python setup.py test

```

## Run lint

```

$ ./lint.sh

```

## Deploying

1. Create an aws lambda function called `getForecast`.

2. Set the `SF_MSW_API` env vairable to your MSW API key.

```

$ aws configure # Add an account

$ ./publish.sh

```