From 7a72df1bc3169ce4faa2a57474c4769b30f59e61 Mon Sep 17 00:00:00 2001 From: Edward Betts Date: Mon, 2 Oct 2023 20:35:30 +0100 Subject: [PATCH] Initial commit. --- .gitignore | 4 + LICENSE | 21 +++ README.md | 60 +++++++++ agenda/__init__.py | 298 +++++++++++++++++++++++++++++++++++++++++++ agenda/spacexdata.py | 139 ++++++++++++++++++++ run.fcgi | 8 ++ run.py | 6 + templates/index.html | 90 +++++++++++++ web_view.py | 34 +++++ 9 files changed, 660 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 agenda/__init__.py create mode 100644 agenda/spacexdata.py create mode 100755 run.fcgi create mode 100755 run.py create mode 100644 templates/index.html create mode 100755 web_view.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..fb78f4f --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +__pycache__/ +*.py[cod] +__pycache__ +.mypy_cache diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f7df002 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021-2023 Edward Betts + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..4909a0d --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +# Personal Agenda Web App + +This is a Python script that serves as a personal agenda web app. It provides +various information and reminders, including financial dates, holidays, market +openings, and more. You can run this script to get an overview of important +events and data relevant to your schedule and interests. + +## Requirements + +- Python 3 +- Required Python modules (install them using pip): + - dateutil + - exchange_calendars + - holidays + - pandas + - pytz + - requests + +## Features + +The agenda web app provides the following features and information: + +- **GBP to USD Exchange Rate**: It fetches the current GBP to USD exchange rate + with caching to minimize API calls. + +- **Next Economist Issue**: Shows the date of the next Economist newspaper + publication. + +- **Next UK Bank Holiday**: Provides the date and title of the next UK bank + holiday. + +- **Next US Holiday**: Displays the date and title of the next US holiday. + +- **Next UK General Election and US Presidential Election**: Shows the dates of + the next UK general election and US presidential election. + +- **SpaceX Launch Schedule**: Lists upcoming SpaceX launches with details. + +- **Stock Markets Opening/Closing Times**: Provides information about stock + market opening and closing times for London and the US. + +- **Next Clock Change**: Shows the next time the clocks change for both the UK + and the US. + +## Customization + +You can customize the script to add or remove features and modify data sources +as needed. + +## License + +This project is licensed under the MIT License. Feel free to use, modify, and +distribute it as per the license terms. See the [LICENSE](LICENSE) file for details. + +## Contact + +If you have any questions or need assistance, feel free to contact the project +maintainer: + +- [Edward Betts](mailto:edward@4angle.com) diff --git a/agenda/__init__.py b/agenda/__init__.py new file mode 100644 index 0000000..4786763 --- /dev/null +++ b/agenda/__init__.py @@ -0,0 +1,298 @@ +#!/usr/bin/python3 + +import configparser +import json +import os +import sys +import typing +import warnings +from datetime import date, datetime, timedelta, timezone +from decimal import Decimal +from time import time as unixtime + +import dateutil +import dateutil.parser +import exchange_calendars +import holidays +import pandas +import pytz +import requests + +from agenda import spacexdata + +# import trading_calendars + + +warnings.simplefilter(action="ignore", category=FutureWarning) + + +# bin and recycling information +# birthdays +# conferences +# end of financial year: 5 April +# deadline to file tax return +# Christmas day +# last Christmas posting day +# wedding anniversary +# DONE: markets open/close +# DONE: next bank holiday +# DONE: economist +# could know about the Christmas double issue +# economist technology quarterly +# credit card expiry dates +# morzine ski lifts +# chalet availablity calendar + +# sunrise and sunset +# starlink visible +# next installment of the Up TV series: 70 Up in 2026 + +# end of Amazon Prime + +# mother's day - fourth Sunday of Lent +# father's day - third Sunday of June + +here = dateutil.tz.tzlocal() +now = datetime.now() +today = now.date() +now_str = now.strftime("%Y-%m-%d_%H:%M") +now_utc = datetime.now(timezone.utc) +data_dir = "/home/edward/lib/data" +do_refresh = len(sys.argv) > 1 and sys.argv[1] == "--refresh" + +next_us_presidential_election = date(2024, 11, 5) +next_uk_general_election = date(2024, 5, 2) +uk_lockdown_start = datetime(2020, 3, 23, 20, 30) + +config = configparser.ConfigParser() +config.read(os.path.join(os.path.dirname(__file__), "config")) + +access_key = config.get("exchangerate", "access_key") + + +def get_next_timezone_transition(tz_name: str) -> datetime: + """Datetime of the next time the clocks change.""" + tz = pytz.timezone(tz_name) + dt = next(t for t in tz._utc_transition_times if t > now) + + return typing.cast(datetime, dt) + + +def get_next_bank_holiday() -> dict[str, date | str]: + """Date and name of the next UK bank holiday.""" + url = "https://www.gov.uk/bank-holidays.json" + filename = os.path.join(data_dir, "bank-holidays.json") + mtime = os.path.getmtime(filename) + if (unixtime() - mtime) > 3600: # one hour + r = requests.get(url) + open(filename, "w").write(r.text) + + events = json.load(open(filename))["england-and-wales"]["events"] + next_holiday = None + for event in events: + event_date = datetime.strptime(event["date"], "%Y-%m-%d").date() + if event_date < today: + continue + next_holiday = {"date": event_date, "title": event["title"]} + break + + assert next_holiday + + return next_holiday + + +def get_gbpusd() -> Decimal: + """Get the current value for GBPUSD, with caching.""" + fx_dir = os.path.join(data_dir, "fx") + existing_data = os.listdir(fx_dir) + existing = [f for f in existing_data if f.endswith("_GBPUSD.json")] + if existing: + recent_filename = max(existing) + recent = datetime.strptime(recent_filename, "%Y-%m-%d_%H:%M_GBPUSD.json") + delta = now - recent + + if not do_refresh and existing and delta < timedelta(hours=6): + full = os.path.join(fx_dir, recent_filename) + data = json.load(open(full), parse_float=Decimal) + if "quotes" in data and "USDGBP" in data["quotes"]: + return typing.cast(Decimal, 1 / data["quotes"]["USDGBP"]) + + # url = 'https://api.exchangeratesapi.io/latest?base=GBP&symbols=USD' + # url = "https://api.exchangerate.host/latest?base=GBP&symbols=USD" + url = "http://api.exchangerate.host/live" + params = {"currencies": "GBP,USD", "access_key": access_key} + + filename = f"{fx_dir}/{now_str}_GBPUSD.json" + r = requests.get(url, params=params) + open(filename, "w").write(r.text) + data = json.loads(r.text, parse_float=Decimal) + + return typing.cast(Decimal, 1 / data["quotes"]["USDGBP"]) + + +def next_economist() -> date: + """Next date that the Economist is published.""" + # TODO: handle the Christmas double issue correctly + return today + timedelta((3 - today.weekday()) % 7) + + +def timedelta_display(delta: timedelta) -> str: + """Format timedelta as a human readable string.""" + total_seconds = int(delta.total_seconds()) + days, remainder = divmod(total_seconds, 24 * 60 * 60) + hours, remainder = divmod(remainder, 60 * 60) + mins, secs = divmod(remainder, 60) + + return " ".join( + f"{v:>3} {label}" + for v, label in ((days, "days"), (hours, "hrs"), (mins, "mins")) + if v + ) + + +def stock_markets() -> list[str]: + """Stock markets open and close times.""" + # The trading calendars code is slow, maybe there is a faster way to do this + # Or we could cache the result + now = pandas.Timestamp.now(timezone.utc) + now_local = pandas.Timestamp.now(here) + markets = [ + ("XLON", "London"), + ("XNYS", "US"), + ] + reply = [] + for code, label in markets: + cal = exchange_calendars.get_calendar(code) + + if cal.is_open_on_minute(now_local): + next_close = cal.next_close(now).tz_convert(here) + next_close = next_close.replace(minute=round(next_close.minute, -1)) + delta_close = timedelta_display(next_close - now_local) + + prev_open = cal.previous_open(now).tz_convert(here) + prev_open = prev_open.replace(minute=round(prev_open.minute, -1)) + delta_open = timedelta_display(now_local - prev_open) + + msg = ( + f"{label:>6} market opened {delta_open} ago, " + + f"closes in {delta_close} ({next_close:%H:%M})" + ) + else: + ts = cal.next_open(now) + ts = ts.replace(minute=round(ts.minute, -1)) + ts = ts.tz_convert(here) + delta = timedelta_display(ts - now_local) + msg = f"{label:>6} market opens in {delta}" + ( + f" ({ts:%H:%M})" if (ts - now_local) < timedelta(days=1) else "" + ) + + reply.append(msg) + return reply + + +def get_us_holiday() -> dict[str, date | str]: + """Date and name of next US holiday.""" + hols = holidays.UnitedStates(years=[today.year, today.year + 1]) + next_hol = next(x for x in sorted(hols.items()) if x[0] >= today) + + return {"date": next_hol[0], "title": next_hol[1]} + + +def days_since_lockdown_start() -> float: + """Days since the start of the first UK Covid lockdown in 2020.""" + return (now - uk_lockdown_start).total_seconds() / (3600 * 24) + + +def get_data() -> dict[str, str | object]: + """Get data to display on agenda dashboard.""" + reply = { + "now": now, + "gbpusd": get_gbpusd(), + # "lockdown_days": days_since_lockdown_start(), + "next_economist": next_economist(), + "bank_holiday": get_next_bank_holiday(), + "us_holiday": get_us_holiday(), + "next_uk_general_election": next_uk_general_election, + "next_us_presidential_election": next_us_presidential_election, + # "spacex": spacexdata.get_next_spacex_launch(limit=20), + "stock_markets": stock_markets(), + "uk_clock_change": get_next_timezone_transition("Europe/London"), + "us_clock_change": get_next_timezone_transition("America/New_York"), + } + + return reply + + +def main(): + ocado = datetime(2021, 1, 21, 9, 30) + ocado_last_edit = datetime(2021, 1, 20, 22, 10) + + # stamp_duty_holiday = date(2021, 3, 31) + + gbpusd = get_gbpusd() + spacex = spacexdata.get_next_spacex_launch(limit=20) + + bank_holiday = get_next_bank_holiday() + + us_holiday = get_us_holiday() + + lockdown_days = (now - uk_lockdown_start).total_seconds() / (3600 * 24) + + def days_hours(when): + delta = when - (now if when.tzinfo is None else now_utc) + return f"{delta.days:>5,d} days {delta.seconds // 3600:>2.0f} hours" + + def days(when): + return " today" if when == today else f"{(when - today).days:>5,d} days" + + print() + print(f"Today is {now:%A, %-d %b %Y} GBPUSD: {gbpusd:,.3f}") + print() + print( + f" lockdown: {lockdown_days:.1f} days ({lockdown_days / 7:.2f} weeks) so far" + ) + if ocado_last_edit > now: + print( + f" Ocado last edit: {days_hours(ocado_last_edit):19s} {ocado_last_edit:%a, %d %b %H:%M}" + ) + + if ocado_last_edit > now: + print(f" Ocado delivery: {days_hours(ocado):9s} {ocado:%a, %d %b %H:%M}") + # print(f' sitar: {days_hours(sitar)} {sitar:%a, %d %b %H:%M}') + print(f" The Economist: {days(next_economist()):20s} (Thursday)") + print( + f' UK bank holiday: {days(bank_holiday["date"]):20s} {bank_holiday["date"]:%a, %d %b} {bank_holiday["title"]}' + ) + print( + f' US holiday: {days(us_holiday["date"]):20s} {us_holiday["date"]:%a, %d %b} {us_holiday["title"]}' + ) + # print(f'stamp duty holiday: {days(stamp_duty_holiday):20s} {stamp_duty_holiday:%a, %d %b}') + print( + f" general election: {days(next_uk_general_election):20s} {next_uk_general_election:%a, %d %b %Y}" + ) + print( + f" US pres. election: {days(next_us_presidential_election):20s} {next_us_presidential_election:%a, %d %b %Y}" + ) + # print(f' Amazon prime: {days(amazon_prime):18s} {amazon_prime:%a, %d %b}') + # print(f'extend transition: {days_hours(extend_transition_deadline)} {extend_transition_deadline:%a, %d %b %H:%M} deadline to extend the transition period ') + + print() + + print(" SpaceX launchs") + for launch in spacex: + if launch["when"] > now_utc + timedelta(days=120): + continue + if launch["date_precision"] == "day": + print( + f' {days(launch["when"].date()):>8s} {launch["when"]:%a, %d %b} {launch["name"]} ({launch["rocket"]}, {" + ".join(launch["payloads"])})', + launch["date_precision"], + ) + else: + print( + f' {days_hours(launch["when"])} {launch["when"]:%a, %d %b %H:%M} {launch["name"]} ({launch["rocket"]}, {" + ".join(launch["payloads"])})', + launch["date_precision"] or "", + ) + + print() + for line in stock_markets(): + print(line) diff --git a/agenda/spacexdata.py b/agenda/spacexdata.py new file mode 100644 index 0000000..60b99d2 --- /dev/null +++ b/agenda/spacexdata.py @@ -0,0 +1,139 @@ +import json +import os +import sys +from datetime import datetime, timezone +from typing import Any + +import dateutil +import dateutil.parser +import requests + +data_dir = "/home/edward/lib/data" +spacex_dir = os.path.join(data_dir, "spacex") + +now = datetime.now() +here = dateutil.tz.tzlocal() +do_refresh = len(sys.argv) > 1 and sys.argv[1] == "--refresh" + +Launch = dict[str, str | datetime | list[Any]] + + +def filename_timestamp(filename: str) -> tuple[datetime, str] | None: + """Get datetime from filename.""" + try: + ts = datetime.strptime(filename, "%Y-%m-%d_%H:%M:%S.json") + except ValueError: + return None + return (ts, filename) + + +def next_spacex_launch_api(limit: int) -> list[Launch]: + """Get the next upcoming launches from the API.""" + filename = os.path.join(spacex_dir, now.strftime("%Y-%m-%d_%H:%M:%S.json")) + url = "https://api.spacexdata.com/v4/launches/upcoming" + + params: dict[str, str | int] = dict(tbd="false", limit=limit) + r = requests.get(url, params=params) + open(filename, "w").write(r.text) + launch_list = r.json() + if "error" in launch_list: + print(r.url) + print(launch_list) + raise ValueError + return [ + parse_get_next_spacex_launch(launch) + for launch in launch_list + if launch["date_precision"] not in ("month", "quarter", "half") + ] + + +def get_spacex_payloads() -> dict[str, str]: + """Load SpaceX payloads or refresh if missing.""" + filename = os.path.join(spacex_dir, "payloads.json") + if not os.path.exists(filename): + refresh_payloads() + data = json.load(open(filename)) + # print(json.dumps(data, indent=2)) + for p in data: + if "type" in p: + continue + print(json.dumps(p, indent=2)) + return {p["id"]: p["type"] for p in data} + + +def get_spacex_rockets() -> dict[str, str]: + """Load mapping of rocket ID to rocket name.""" + filename = os.path.join(spacex_dir, "rockets.json") + return {r["id"]: r["name"] for r in json.load(open(filename))} + + +def refresh_payloads() -> None: + """Download list of payloads and save.""" + url = "https://api.spacexdata.com/v4/payloads" + filename = os.path.join(spacex_dir, "payloads.json") + r = requests.get(url) + open(filename, "w").write(r.text) + + +rocket_map = get_spacex_rockets() +payloads = get_spacex_payloads() + + +def parse_get_next_spacex_launch(launch: dict[str, Any]) -> Launch: + global payloads + date_utc = dateutil.parser.parse(launch["date_utc"]) + date_utc.replace(tzinfo=timezone.utc) + + # TODO: payload + + need_refresh = any(p not in payloads for p in launch["payloads"]) + if need_refresh: + refresh_payloads() + payloads = get_spacex_payloads() + assert all(p in payloads for p in launch["payloads"]) + + return { + "rocket": rocket_map[launch["rocket"]], + "name": launch["name"], + "when": date_utc.astimezone(here), + "date_precision": launch["date_precision"], + "payloads": [payloads.get(p, "[unknown payload]") for p in launch["payloads"]], + } + + +def get_most_recent_existing(existing): + for _, f in existing: + filename = os.path.join(spacex_dir, f) + launch_list = json.load(open(filename)) + if "error" in launch_list: + print(launch_list) + continue + + return launch_list + + +def get_next_spacex_launch(limit: int) -> list[Launch]: + filename = os.path.join(data_dir, "next_spacex_launch.json") + spacex_dir = os.path.join(data_dir, "spacex") + + existing = [x for x in (filename_timestamp(f) for f in os.listdir(spacex_dir)) if x] + + existing.sort(reverse=True) + + if do_refresh or not existing or (now - existing[0][0]).seconds > 3600: # one hour + try: + return next_spacex_launch_api(limit=limit) + except ValueError: + print("*** SpaceX next launch error ***") + + for _, f in existing: + filename = os.path.join(spacex_dir, f) + launch_list = json.load(open(filename)) + if "error" in launch_list: + print(launch_list) + continue + return [ + parse_get_next_spacex_launch(launch) + for launch in launch_list + if launch["date_precision"] not in ("month", "quarter", "half") + ] diff --git a/run.fcgi b/run.fcgi new file mode 100755 index 0000000..851231a --- /dev/null +++ b/run.fcgi @@ -0,0 +1,8 @@ +#!/usr/bin/python3 +from flipflop import WSGIServer +import sys +sys.path.append('/home/edward/src/2021/agenda') +from web_view import app + +if __name__ == '__main__': + WSGIServer(app).run() diff --git a/run.py b/run.py new file mode 100755 index 0000000..b283063 --- /dev/null +++ b/run.py @@ -0,0 +1,6 @@ +#!/usr/bin/python3 + +from agenda import main + +if __name__ == "__main__": + main() diff --git a/templates/index.html b/templates/index.html new file mode 100644 index 0000000..0b99c5d --- /dev/null +++ b/templates/index.html @@ -0,0 +1,90 @@ + + + + + + Agenda + + + + + +
+

Agenda

+ +
    +
  • Today is {{now.strftime("%A, %-d %b %Y")}}
    • +
  • GBPUSD: {{"{:,.3f}".format(gbpusd)}}
    • + {#
  • lock down: + {{"{:.1f}".format(lockdown_days)}} days + ({{"{:.2f}".format(lockdown_days / 7)}} weeks) so far
    • #} +
  • The Economist: {{days(next_economist)}} (Thursday)
    • +
  • UK bank holiday: + {{days(bank_holiday["date"])}} + {{bank_holiday["date"].strftime("%a, %d %b")}} + {{bank_holiday["title"]}}
    • + +
  • US holiday: + {{days(us_holiday["date"])}} + {{us_holiday["date"].strftime("%a, %d %b")}} + {{us_holiday["title"]}}
    • + +
  • UK clock change: + {{days(uk_clock_change.date())}} + {{uk_clock_change.strftime("%a, %d, %b %Y")}}
    • + +
  • US clock change: + {{days(us_clock_change.date())}} + {{us_clock_change.strftime("%a, %d, %b %Y")}}
    • + + {# +
  • general election: + {{days(next_uk_general_election)}} + {{next_uk_general_election.strftime("%a, %d %b %Y")}}
    • #} +
  • US pres. election: + {{days(next_us_presidential_election)}} + {{next_us_presidential_election.strftime("%a, %d %b %Y")}}
    • +
+ +

Stock markets

+ {% for market in stock_markets %} +

{{ market }}

+ {% endfor %} + + {# +

SpaceX launches

+ + {% for launch in spacex %} + + {% if launch["date_precision"] == "day" %} + + + + {% else %} + + + + {% endif %} + + + + + + {% endfor %} + +
+ {{ days(launch["when"].date()) }} + + {{ launch["when"].strftime("%a, %d %b") }} + + + {{ days_hours(launch["when"]) }} + + {{ launch["when"].strftime("%a, %d %b") }} + + {{ launch["when"].strftime("%H:%M") }} + {{ launch["name"] }}{{ launch["rocket"] }}{{ launch["payloads"] | join(" + ") }}{{ launch["date_precision"] }}
+ #} + + + diff --git a/web_view.py b/web_view.py new file mode 100755 index 0000000..e2e9da9 --- /dev/null +++ b/web_view.py @@ -0,0 +1,34 @@ +#!/usr/bin/python3 + +"""Web page to show upcoming events.""" + +from datetime import date, datetime, timezone + +from flask import Flask, render_template + +from agenda import get_data + +app = Flask(__name__) +app.debug = True + + +@app.route("/") +def index() -> str: + """Index page.""" + data = get_data() + now = datetime.now() + today = now.date() + now_utc = datetime.now(timezone.utc) + + def days_hours(when: datetime) -> str: + delta = when - (now if when.tzinfo is None else now_utc) + return f"{delta.days:>5,d} days {delta.seconds // 3600:>2.0f} hours" + + def days(when: date) -> str: + return " today" if when == today else f"{(when - today).days:>5,d} days" + + return render_template("index.html", days=days, days_hours=days_hours, **data) + + +if __name__ == "__main__": + app.run(host="0.0.0.0")