gemtide 0.1.0

A Jetforce application for serving information about UK tidal events over the Gemini Protocol

GemTide

A Jetforce application for serving information about UK tidal events over the Gemini Protocol.

Take a look | Report a bug | Contact the author

Built with

• Jetforce - framework for writing Gemini applications
• UKHO Tides - client wrapper for the Admiralty UK Tidal API
• Jinja2 - templating engine

Requirements

• Python 3.7 or newer
• API key for the UK Tidal API from Admiralty Maritime Data Solutions Developer Portal. The Discovery subscription is free and provides current plus 6 days' worth of events. Follow the Start up guide for help.

Getting Started

Recommended

Create a virtual environment

$ mkdir /opt/gemtide
$ python3 -m venv /opt/gemtide/venv
$ python3 -m pip install -U pip
$ . /opt/gemtide/venv/bin/activate

Installation

From pip

$ pip install gemtide

Or, from source

$ git clone https://git.sr.ht/~supergrizzlybear/gemtide
$ cd gemtide
$ pip install .

Create file config.yaml and add:

api_key: Your UK Tidal API key
station_prefix: (Optional) the path / prefix that the responses will be served with

Usage

Run the application with a default Jetforce server

$ python3 -m gemtide [config.yaml]

Or, if using a virtual environment

$ /opt/venv/gemtide/bin/gemtide [config.yaml]

Custom Jetforce application

See Jetforce README section on Virtual Hosting

Usage

from jetforce import GeminiServer
from gemtide import GemTideApplication

app = GemTideApplication(api_key, station_prefix="location/")
server = GeminiServer(app)
server.run()

Developing

Create a virtual environment

$ mkdir /opt/gemtide
$ python3 -m venv /opt/gemtide/venv
$ python3 -m pip install --upgrade pip
$ . /opt/gemtide/venv/bin/activate

Clone the repository

$ git clone [e-mail]:~supergrizzlybear/gemtide
$ cd gemtide

Install requirements

$ pip install -r requrements.txt

Test

$ python3 test_gemtide.py

License

This project is licensed under the Floodgap Free Software License.

The Floodgap Free Software License (FFSL) has one overriding mandate: that software using it, or derivative works based on software that uses it, must be free. By free we mean simply "free as in beer" -- you may put your work into open or closed source packages as you see fit, whether or not you choose to release your changes or updates publicly, but you must not ask any fee for it.

Contact

• Email: [e-mail]
• Mastodon: @[e-mail]
• Gemini: super.grizzlybear.site