aims-convert 1.2__tar.gz

aims-convert-1.2/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.1
+Name: aims-convert
+Version: 1.2
+Summary: Extract information from AIMS detailed roster
+Home-page: https://github.com/JonHurst/aims-convert
+Author: Jon Hurst
+Author-email: jon.a@hursts.org.uk
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: requests
+Requires-Dist: nightflight
+
+# AIMS Roster Data Extraction #
+
+This will primarily be of interest to easyJet pilots. It extracts data from a
+“detailed roster” as can be downloaded from AIMS. Pilots from other airlines
+that use AIMS *may* also find this useful — it has only been tested against the
+files from easyJet’s version of AIMS (as that is all that I have access to), so
+its utility will depend on whether whatever version is being used by your
+airline produces sufficiently similar output.
+
+As well as extracting the data from the AIMS roster, the registration and type
+of the aircraft operating the sectors is looked up, and a night flying
+calculation is carried out.
+
+The three main formats that the data can be extracted to are electronic Flight
+Journal (eFJ), iCalendar and CSV.
+
+An eFJ is a text file that can be used to store personal flight data in an
+intuitive non-tabular form. Full details of the format of this text file can be
+found at <https://hursts.org.uk/efjdocs/format.html>, and an online tool
+capable of converting this format to an FCL.050 compliant logbook in HTML
+format can be found at <https://hursts.org.uk/efj>.
+
+The iCalendar format can be imported into most calendar applications. There is
+an option to include full day events such as days off. This is useful for
+managing and sharing your future roster.
+
+The CSV format is for keeping logbook data in a spreadsheet.
+
+The package provides entry points for a command line interface, a Tk based
+graphical interface and an AWS lambda function. The AWS function is hooked up
+to a website at <https://hursts.org.uk/aims>, which requires no installation,
+just a browser. The other two interfaces require the installation of a Python
+interpreter.

aims-convert-1.2/README.md

@@ -0,0 +1,33 @@
+# AIMS Roster Data Extraction #
+
+This will primarily be of interest to easyJet pilots. It extracts data from a
+“detailed roster” as can be downloaded from AIMS. Pilots from other airlines
+that use AIMS *may* also find this useful — it has only been tested against the
+files from easyJet’s version of AIMS (as that is all that I have access to), so
+its utility will depend on whether whatever version is being used by your
+airline produces sufficiently similar output.
+
+As well as extracting the data from the AIMS roster, the registration and type
+of the aircraft operating the sectors is looked up, and a night flying
+calculation is carried out.
+
+The three main formats that the data can be extracted to are electronic Flight
+Journal (eFJ), iCalendar and CSV.
+
+An eFJ is a text file that can be used to store personal flight data in an
+intuitive non-tabular form. Full details of the format of this text file can be
+found at <https://hursts.org.uk/efjdocs/format.html>, and an online tool
+capable of converting this format to an FCL.050 compliant logbook in HTML
+format can be found at <https://hursts.org.uk/efj>.
+
+The iCalendar format can be imported into most calendar applications. There is
+an option to include full day events such as days off. This is useful for
+managing and sharing your future roster.
+
+The CSV format is for keeping logbook data in a spreadsheet.
+
+The package provides entry points for a command line interface, a Tk based
+graphical interface and an AWS lambda function. The AWS function is hooked up
+to a website at <https://hursts.org.uk/aims>, which requires no installation,
+just a browser. The other two interfaces require the installation of a Python
+interpreter.

aims-convert-1.2/aims/airframe_lookup.py

@@ -0,0 +1,20 @@
+import requests
+from aims.roster import Sector
+
+
+def sector_id(sector: Sector) -> str:
+    return f'{sector.off:%Y%m%dT%H%M}F{sector.name}'
+
+
+def airframes(sectors: tuple[Sector, ...]) -> dict[str, tuple[str, str]]:
+    ids = [sector_id(X) for X in sectors if X.from_]
+    try:
+        r = requests.post(
+            "https://efwj6ola8d.execute-api.eu-west-1.amazonaws.com/"
+            "default/reg",
+            json={'flights': ids})
+        r.raise_for_status()
+        regntype_map = r.json()
+    except requests.exceptions.RequestException:
+        return {}  # if anything goes wrong, just return empty dict
+    return regntype_map

aims-convert-1.2/aims/cli.py

@@ -0,0 +1,43 @@
+#!/usr/bin/python3
+
+import sys
+import argparse
+
+import aims.roster as roster
+import aims.output as output
+
+
+def _args():
+    parser = argparse.ArgumentParser(
+        description=(
+            'Process an AIMS detailed roster into various useful formats.'))
+    parser.add_argument('format',
+                        choices=['roster', 'efj', 'csv', 'ical'])
+    parser.add_argument('--ade', action="store_true")
+    return parser.parse_args()
+
+
+def main() -> int:
+    args = _args()
+    lines = roster.lines(sys.stdin.read())
+    columns = roster.columns(lines)
+    sectors = roster.sectors(columns)
+    if args.format == "roster":
+        print(output.roster(sectors))
+    elif args.format == "efj":
+        print(output.efj(
+            sectors,
+            roster.crew_dict(lines)))
+    elif args.format == "csv":
+        print(output.csv(
+            sectors,
+            roster.crew_dict(lines)))
+    elif args.format == "ical":
+        ade = roster.all_day_events(columns) if args.ade else ()
+        print(output.ical(sectors, ade))
+    return 0
+
+
+if __name__ == "__main__":
+    retval = main()
+    sys.exit(retval)

aims-convert-1.2/aims/gui.py

@@ -0,0 +1,439 @@
+import os.path
+import json
+import tkinter as tk
+from tkinter import ttk
+from tkinter import messagebox
+from tkinter import filedialog
+import ctypes
+
+import aims.roster as roster
+
+from aims.output import csv, ical, efj
+
+VERSION = "1.2"
+
+SETTINGS_FILE = os.path.expanduser("~/.aimsgui")
+
+
+class ModeSelector(ttk.Frame):
+
+    def __init__(self, parent, with_ade):
+        ttk.Frame.__init__(self, parent)
+        self.output_type = tk.StringVar()
+        self.output_type.set('efj')
+        self.with_ade = tk.BooleanVar()
+        self.with_ade.set(with_ade)
+        self.__make_widgets()
+
+    def __make_widgets(self):
+        frm_output_type = ttk.LabelFrame(self, text="Output type")
+        frm_output_type.pack(fill=tk.X, expand=True, ipadx=5, pady=5)
+        efj_output = ttk.Radiobutton(
+            frm_output_type, text=" Flight Journal",
+            variable=self.output_type, value='efj',
+            command=self.output_type_changed)
+        efj_output.pack(fill=tk.X)
+        csv_output = ttk.Radiobutton(
+            frm_output_type, text=" Logbook (.csv)",
+            variable=self.output_type, value='csv',
+            command=self.output_type_changed)
+        csv_output.pack(fill=tk.X)
+        ical_output = ttk.Radiobutton(
+            frm_output_type, text=" Roster (.ics)",
+            variable=self.output_type, value='ical',
+            command=self.output_type_changed)
+        ical_output.pack(fill=tk.X)
+
+        self.frm_ical_options = ttk.LabelFrame(self, text="Options")
+        with_ade = ttk.Checkbutton(self.frm_ical_options,
+                                   text=" All Day Events",
+                                   variable=self.with_ade,
+                                   command=self.options_changed)
+        with_ade.pack(fill=tk.X)
+
+    def output_type_changed(self):
+        assert self.output_type.get() in ('csv', 'ical', 'efj')
+        if self.output_type.get() == 'ical':
+            self.frm_ical_options.pack(fill=tk.X, expand=True, ipadx=5, pady=5)
+        else:
+            self.frm_ical_options.pack_forget()
+        self.event_generate("<<ModeChange>>", when="tail")
+
+    def options_changed(self):
+        self.event_generate("<<OptionChange>>", when="tail")
+
+
+class Actions(ttk.Frame):
+
+    def __init__(self, parent):
+        ttk.Frame.__init__(self, parent)
+        self.__make_widgets()
+
+    def __make_widgets(self):
+        frm_1 = ttk.Frame(self)
+        frm_1.pack(fill=tk.X)
+        btn_convert = ttk.Button(
+            frm_1, text="Load Roster", width=0,
+            command=lambda: self.event_generate("<<Action-Import>>"))
+        btn_convert.pack(fill=tk.X)
+
+        frm_2 = ttk.Frame(self)
+        frm_2.pack(fill=tk.X, pady=10)
+        btn_save = ttk.Button(
+            frm_2, text="Save", width=0,
+            command=lambda: self.event_generate("<<Action-Save>>"))
+        btn_save.pack(fill=tk.X, pady=2)
+        self.btn_copy = ttk.Button(
+            frm_2, text="Copy All", width=0,
+            command=lambda: self.event_generate("<<Action-Copy>>"))
+        self.btn_copy.pack(fill=tk.X, pady=2)
+
+        frm_3 = ttk.Frame(self)
+        frm_3.pack(fill=tk.X)
+        btn_quit = ttk.Button(
+            frm_3, text="Quit", width=0,
+            command=lambda: self.event_generate("<<Action-Quit>>"))
+        btn_quit.pack(fill=tk.X)
+
+    def set_copy_selected(self, selected):
+        if selected:
+            self.btn_copy.config(text="Copy Selected")
+        else:
+            self.btn_copy.config(text="Copy All")
+
+
+class TextWithSyntaxHighlighting(tk.Text):
+
+    def __init__(self, parent=None, **kwargs):
+        tk.Text.__init__(self, parent, background='white',
+                         wrap="none", **kwargs)
+        self.highlight_mode = None
+        self.tag_configure("grayed", foreground="#909090")
+        self.tag_configure("keyword", foreground="green")
+        self.tag_configure("datetime", foreground="blue")
+        self.bind(
+            '<KeyRelease>',
+            lambda *args: self.edit_modified() and self.highlight_syntax())
+
+    def insert(self, idx, text, mode=None, *args):
+        tk.Text.insert(self, idx, text, *args)
+        if mode:
+            self.highlight_mode = mode
+            self.highlight_syntax()
+
+    def highlight_syntax(self):
+        if not self.highlight_mode:
+            return
+        for tag in ("keyword", "datetime", "grayed"):
+            self.tag_remove(tag, "1.0", "end")
+        if self.highlight_mode == 'ical':
+            self.highlight_vcalendar()
+        elif self.highlight_mode == 'csv':
+            self.highlight_csv()
+        elif self.highlight_mode == 'efj':
+            self.highlight_efj()
+        self.edit_modified(False)
+
+    def highlight_vcalendar(self):
+        count = tk.IntVar()
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                "(BEGIN|END):VEVENT",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("keyword", new_idx, start_idx)
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r"^[\w-]+:",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("grayed", new_idx, start_idx)
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r"\d{4}-\d{2}-\d{2}T\d{2}:\d{2}",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("datetime", new_idx, start_idx)
+
+    def highlight_csv(self):
+        count = tk.IntVar()
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r"\d{4}-\d{2}-\d{2} \d{2}:\d{2}",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("datetime", new_idx, start_idx)
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r'(:00)?[",]+',
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("grayed", new_idx, start_idx)
+
+    def highlight_efj(self):
+        count = tk.IntVar()
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r"\d{4}-\d{2}-\d{2}",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("datetime", new_idx, start_idx)
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                r"\d{4}/\d{4}",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("datetime", new_idx, start_idx)
+        start_idx = "1.0"
+        while True:
+            new_idx = self.search(
+                "CP:|FO:|PU:|FA:",
+                start_idx, count=count, regexp=True,
+                stopindex="end")
+            if not new_idx:
+                break
+            start_idx = f"{new_idx} + {count.get()} chars"
+            self.tag_add("keyword", new_idx, start_idx)
+
+
+class MainWindow(ttk.Frame):
+
+    def __init__(self, parent):
+        ttk.Frame.__init__(self, parent)
+        self.parent = parent
+        try:
+            with open(SETTINGS_FILE) as f:
+                self.settings = json.load(f)
+        except Exception:
+            self.settings = {}
+        self.__make_widgets()
+        self.txt.insert(tk.END, f"Version: {VERSION}")
+        self.copy_mode = "all"
+
+    def __make_widgets(self):
+        self.columnconfigure(1, weight=1)
+        self.rowconfigure(0, weight=1)
+        sb = ttk.Scrollbar(self, orient='vertical')
+        sbx = ttk.Scrollbar(self, orient='horizontal')
+        sb.grid(row=0, column=2, sticky=tk.NS)
+        sbx.grid(row=1, column=1, sticky=tk.EW)
+        sidebar = ttk.Frame(self, width=0)
+        sidebar.grid(row=0, column=0, sticky=tk.NS, padx=5, pady=5)
+        self.txt = TextWithSyntaxHighlighting(self)
+        self.txt.grid(row=0, column=1, sticky=tk.NSEW)
+        sb.config(command=self.txt.yview)
+        sbx.config(command=self.txt.xview)
+        self.txt.config(yscrollcommand=sb.set)
+        self.txt.config(xscrollcommand=sbx.set)
+        self.txt.bind("<<Selection>>", self.__on_selection_change)
+
+        sidebar.rowconfigure(1, weight=1)
+        self.ms = ModeSelector(sidebar,
+                               self.settings.get('ADE', True))
+        self.ms.bind("<<ModeChange>>", self.__on_mode_change)
+        self.ms.bind("<<OptionChange>>", self.__on_option_change)
+        self.ms.grid(row=0, sticky=tk.N)
+        self.act = Actions(sidebar)
+        self.act.grid(row=1, sticky=(tk.EW + tk.S))
+        for event, func in (
+                ("<<Action-Import>>", self.__import),
+                ("<<Action-Copy>>", self.__copy),
+                ("<<Action-Save>>", self.__save),
+                ("<<Action-Quit>>", lambda _: self.parent.destroy())):
+            self.act.bind(event, func)
+        self.act.set_copy_selected(False)
+
+    def __on_mode_change(self, _):
+        self.txt.delete('1.0', tk.END)
+
+    def __on_option_change(self, _):
+        self.settings['ADE'] = self.ms.with_ade.get()
+        self.txt.delete('1.0', tk.END)
+
+    def __on_selection_change(self, _):
+        if self.txt.tag_ranges("sel"):
+            if self.copy_mode == "sel":
+                return
+            self.copy_mode = "sel"
+            self.act.set_copy_selected(True)
+        else:
+            self.copy_mode = "all"
+            self.act.set_copy_selected(False)
+
+    def __import(self, _):
+        assert self.ms.output_type.get() in ('csv', 'ical', 'efj')
+        try:
+            if self.ms.output_type.get() == 'efj':
+                self.__efj()
+            elif self.ms.output_type.get() == 'csv':
+                self.__csv()
+            else:
+                self.__ical()
+        except roster.RosterException as e:
+            self.txt.delete('1.0', tk.END)
+            messagebox.showerror("Error", str(e))
+
+    def __roster_html(self):
+        retval = ""
+        path = self.settings.get('openPath')
+        fn = filedialog.askopenfilename(
+            filetypes=(
+                ("HTML file", "*.htm"),
+                ("HTML file", "*.html"),
+                ("All", "*.*")),
+            initialdir=path)
+        if fn:
+            self.settings['openPath'] = os.path.dirname(fn)
+            try:
+                with open(fn) as f:
+                    retval = f.read()
+            except Exception:
+                raise roster.InputFileException
+        return retval
+
+    def __csv(self):
+        txt = ""
+        html = self.__roster_html()
+        if not html:
+            return
+        self.txt.delete('1.0', tk.END)
+        self.txt.insert(tk.END, "Getting registration and type info...")
+        self.txt.update()
+
+        lines = roster.lines(html)
+        sectors = tuple(X for X in roster.sectors(roster.columns(lines))
+                        if X.from_)
+        if not sectors:
+            messagebox.showinfo('Sectors', 'No relevant sectors found')
+            self.txt.delete('1.0', tk.END)
+            return
+        crewlist_map = roster.crew_dict(lines)
+        # note: normalise newlines for Text widget - will restore on output
+        txt = csv(sectors, crewlist_map).replace("\r\n", "\n")
+        self.txt.delete('1.0', tk.END)
+        self.txt.insert(tk.END, txt, 'csv')
+
+    def __ical(self):
+        html = self.__roster_html()
+        if not html:
+            return
+        lines = roster.lines(html)
+        columns = roster.columns(lines)
+        sectors = roster.sectors(columns)
+        ade = roster.all_day_events(columns) if self.ms.with_ade.get() else ()
+        if not sectors:
+            self.txt.delete('1.0', tk.END)
+            messagebox.showinfo('Duties', 'No relevant sectors found')
+            return
+        # note: normalise newlines for Text widget - will restore on output
+        txt = ical(sectors, ade).replace("\r\n", "\n")
+        self.txt.delete('1.0', tk.END)
+        self.txt.insert(tk.END, txt, 'ical')
+
+    def __efj(self):
+        html = self.__roster_html()
+        if not html:
+            return
+        self.txt.delete('1.0', tk.END)
+        self.txt.insert(tk.END, "Working…", 'efj')
+        self.txt.update()
+        lines = roster.lines(html)
+        columns = roster.columns(lines)
+        sectors = roster.sectors(columns)
+        txt = efj(sectors, roster.crew_dict(lines))
+        self.txt.delete('1.0', tk.END)
+        self.txt.insert(tk.END, txt, 'efj')
+
+    def __copy(self, _):
+        self.clipboard_clear()
+        if self.copy_mode == "all":
+            start, end = '1.0', tk.END
+        else:
+            start, end = self.txt.tag_ranges("sel")
+        text = self.txt.get(start, end)
+        # ical and excel dialect csv need DOS style line endings
+        if self.ms.output_type in ('ical', 'csv'):
+            text = text.replace("\n", "\r\n")
+        self.clipboard_append(text)
+        messagebox.showinfo('Copy', 'Text copied to clipboard.')
+
+    def __save(self, _):
+        output_type = self.ms.output_type.get()
+        assert output_type in ('csv', 'ical', 'efj')
+        if output_type == 'csv':
+            pathtype = 'csvSavePath'
+            filetypes = (("CSV file", "*.csv"),
+                         ("All", "*.*"))
+            default_ext = '.csv'
+        elif output_type == 'efj':
+            pathtype = 'efjSavePath'
+            filetypes = (("Text file", "*.txt"),
+                         ("All", "*.*"))
+            default_ext = '.txt'
+        else:
+            pathtype = 'icalSavePath'
+            filetypes = (("ICAL file", "*.ics"),
+                         ("ICAL file", "*.ical"),
+                         ("All", "*.*"))
+            default_ext = '.ics'
+        path = self.settings.get(pathtype)
+        fn = filedialog.asksaveasfilename(
+            initialdir=path,
+            filetypes=filetypes,
+            defaultextension=default_ext)
+        if fn:
+            self.settings[pathtype] = os.path.dirname(fn)
+            with open(fn, "w", encoding="utf-8", newline='') as f:
+                text = self.txt.get('1.0', tk.END)
+                # ical and excel dialect csv need DOS style line endings
+                if output_type in ('ical', 'csv'):
+                    text = text.replace("\n", "\r\n")
+                f.write(text)
+                messagebox.showinfo('Saved', 'Save complete.')
+
+    def destroy(self):
+        with open(SETTINGS_FILE, "w") as f:
+            json.dump(self.settings, f, indent=4)
+        ttk.Frame.destroy(self)
+
+
+def main():
+    if "windll" in dir(ctypes):
+        ctypes.windll.shcore.SetProcessDpiAwareness(1)
+    root = tk.Tk()
+    root.title("aimsgui")
+    mw = MainWindow(root)
+    mw.pack(fill=tk.BOTH, expand=True)
+    root.mainloop()
+
+
+if __name__ == "__main__":
+    main()