Pytide is designed to email a tide report to users for the tide stations they care about. This could be useful for fishing, sailing, surfing, or any other case where tide data is important. Configuration is handled simply in a single file, and the application can be scheduled to run using a task scheduler like cron, systemd, or whatever else to send reports when the user desires.
- Python (See this link for currently-supported versions)
- Google Maps Static API key
- Git (Optional)
You can find tide stations near you by using the NOAA's Tides & Currents page.
Enter the station IDs in your configuration file. You can also specify names for the stations. The idea is that it may be more useful to use "Bob's beach house" as a descriptor than whatever the station's actual name is.
Follow the instructions in config.ini.
Enter the email addresses for each recipient that should receive a copy of the email. These emails will be sent individually. There will not be a single email with multiple recipients CC'd on it.
Follow the instructions in config.ini.
An email server is not provided with this application. You will need to use your own email address and find its SMTP server settings. A stubbed example has been provided, and there are slightly more detailed notes for Gmail users in the configuration file.
Follow the instructions in config.ini.
Normal interactive maps are not embeddable in emails. This project uses Google's Maps Static API to to provide the images. However, an API key is not provided with this application. You must sign up for the service and provide your own API key in order to retrieve map images.
This is not a free service. However, for personal use cases, you are very unlikely to make enough API queries to get charged. Last I checked, it would take roughly 100,000 map images retrieved before charges are incurred.
Follow the instructions in config.ini.
Alternatively, the API key may be provided through the command line using the --maps-api-key
command line option or by specifying a PYTIDE_MAPS_API_KEY environment variable.
- Clone this repository with
git clone https://github.com/pfeif/pytide.git - Install the dependencies with
pip install -r requirements.txt - Run the application using default configuration file with
python pytide/pytide.pyor specify a configuration file withpython pytide/pytide.py --config-file <custom config path and filename>
This project is licensed under the terms of the BSD 3-Clause License. See LICENSE.md for details.