Bump version to 1.0.0

PFERD/__init__.py

@@ -1,12 +1,35 @@
+import logging
+
 from .ffm import *
 from .ilias import *
 from .norbert import *
 from .utils import *
 
-__all__ = []
+__all__ = ["STYLE", "FORMAT", "DATE_FORMAT", "FORMATTER", "enable_logging"]
+
 __all__ += ffm.__all__
 __all__ += ilias.__all__
 __all__ += norbert.__all__
 __all__ += utils.__all__
 
-LOG_FORMAT = "[%(levelname)s] %(message)s"
+STYLE = "{"
+FORMAT = "[{levelname:<7}] {message}"
+DATE_FORMAT = "%F %T"
+
+FORMATTER = logging.Formatter(
+        fmt=FORMAT,
+        datefmt=DATE_FORMAT,
+        style=STYLE,
+)
+
+def enable_logging(name="PFERD", level=logging.INFO):
+    handler = logging.StreamHandler()
+    handler.setFormatter(FORMATTER)
+
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    logger.addHandler(handler)
+
+    # This should be logged by our own handler, and not the root logger's
+    # default handler, so we don't pass it on to the root logger.
+    logger.propagate = False

README.md

@@ -6,7 +6,18 @@ Ensure that you have at least Python 3.7 installed.
 
 To install PFERD or update your installation to the latest version, run:
 ```
-$ pip install git+https://github.com/Garmelon/PFERD@v0.1.0
+$ pip install git+https://github.com/Garmelon/PFERD@v1.0.0
 ```
 
 The use of [venv](https://docs.python.org/3/library/venv.html) is recommended.
+
+A full example setup and initial use could look like:
+```
+$ mkdir Vorlesungen
+$ cd Vorlesungen
+$ python3 -m venv .
+$ . bin/activate
+$ pip install git+https://github.com/Garmelon/PFERD@v1.0.0
+$ curl -O https://raw.githubusercontent.com/Garmelon/PFERD/master/example_config.py
+$ python example_config.py
+```

example_config.py

@@ -1,15 +1,15 @@
 #!/bin/env python3
 
-import PFERD
-import asyncio
-import logging
-import pathlib
 import re
 import sys
 
-logging.basicConfig(level=logging.INFO, format=PFERD.LOG_FORMAT)
+import PFERD
+from PFERD.utils import get_base_dir, move, rename
 
-base_dir = PFERD.get_base_dir(__file__)
+#PFERD.enable_logging(logging.DEBUG)
+PFERD.enable_logging()
+
+base_dir = get_base_dir(__file__)
 
 # Semester 1
 
@@ -24,44 +24,44 @@ def gbi_filter(path):
 
 def gbi_transform(path):
     # Übungsblätter in Blätter/blatt_xx.pdf
-    new_path = PFERD.move(path, ("Übungsblätter",), ("Blätter",))
+    new_path = move(path, ("Übungsblätter",), ("Blätter",))
     if new_path is not None:
 
         match = re.match(r"(\d+).aufgaben.pdf", new_path.name)
         if match:
             number = int(match.group(1))
-            return PFERD.rename(new_path, f"blatt_{number:02}.pdf")
+            return rename(new_path, f"blatt_{number:02}.pdf")
 
         match = re.match(r"(\d+).loesungen.pdf", new_path.name)
         if match:
             number = int(match.group(1))
-            return PFERD.rename(new_path, f"loesung_{number:02}.pdf")
+            return rename(new_path, f"loesung_{number:02}.pdf")
 
         return new_path
 
     # Folien in Folien/*
-    new_path = PFERD.move(path, ("Vorlesung: Folien",), ("Folien",))
+    new_path = move(path, ("Vorlesung: Folien",), ("Folien",))
     if new_path is not None: return new_path
 
     # Skripte in Skripte/*
-    new_path = PFERD.move(path, ("Vorlesung: Skript",), ("Skripte",))
+    new_path = move(path, ("Vorlesung: Skript",), ("Skripte",))
     if new_path is not None:
         if new_path.name == "k-21-relationen-skript.pdf":
-            return PFERD.rename(new_path, "21-relationen-skript.pdf")
+            return rename(new_path, "21-relationen-skript.pdf")
 
         return new_path
 
     # Übungsfolien in Übung/*
-    new_path = PFERD.move(path, ("große Übung: Folien",), ("Übung",))
+    new_path = move(path, ("große Übung: Folien",), ("Übung",))
     if new_path is not None: return new_path
 
     # Tutoriumsfolien in Tutorium/*
-    new_path = PFERD.move(path, ("Tutoriumsfolien","Tutorium 15"), ("Tutorium",))
+    new_path = move(path, ("Tutoriumsfolien","Tutorium 15"), ("Tutorium",))
     if new_path is not None:
         if new_path.name == "GBI_Tut_2 (1).pdf":
-            return PFERD.rename(new_path, "GBI_Tut_2.pdf")
+            return rename(new_path, "GBI_Tut_2.pdf")
         if new_path.name == "GBI_Tut_7 (1).pdf":
-            return PFERD.rename(new_path, "GBI_Tut_7.pdf")
+            return rename(new_path, "GBI_Tut_7.pdf")
 
         return new_path
 
@@ -70,15 +70,15 @@ def gbi_transform(path):
 def hm1_transform(path):
     match = re.match(r"blatt(\d+).pdf", path.name)
     if match:
-        new_path = PFERD.move(path, (), ("Blätter",))
+        new_path = move(path, (), ("Blätter",))
         number = int(match.group(1))
-        return PFERD.rename(new_path, f"blatt_{number:02}.pdf")
+        return rename(new_path, f"blatt_{number:02}.pdf")
 
     match = re.match(r"blatt(\d+).loesungen.pdf", path.name)
     if match:
-        new_path = PFERD.move(path, (), ("Blätter",))
+        new_path = move(path, (), ("Blätter",))
         number = int(match.group(1))
-        return PFERD.rename(new_path, f"loesung_{number:02}.pdf")
+        return rename(new_path, f"loesung_{number:02}.pdf")
 
     return path
 
@@ -95,82 +95,82 @@ def la1_filter(path):
 def la1_transform(path):
     # Alle Übungsblätter in Blätter/blatt_xx.pdf
     # Alles andere Übungsmaterial in Blätter/*
-    new_path = PFERD.move(path, ("Übungen",), ("Blätter",))
+    new_path = move(path, ("Übungen",), ("Blätter",))
     if new_path is not None:
 
         match = re.match(r"Blatt(\d+).pdf", new_path.name)
         if match:
             number = int(match.group(1))
-            return PFERD.rename(new_path, f"blatt_{number:02}.pdf")
+            return rename(new_path, f"blatt_{number:02}.pdf")
 
         if new_path.name == "Lösungen zu Blatt 1, Aufgabe 1 und Blatt 2, Aufgabe 4..pdf":
-            return PFERD.rename(new_path, "Lösungen zu Blatt 1, Aufgabe 1 und Blatt 2, Aufgabe 4.pdf")
+            return rename(new_path, "Lösungen zu Blatt 1, Aufgabe 1 und Blatt 2, Aufgabe 4.pdf")
 
         return new_path
 
     # Alles Tutoriengedöns von Philipp in Tutorium/Philipp/*
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 03 - Philipp Faller"), ("Tutorium","Philipp"))
+    new_path = move(path, ("Tutorien","Tutorium 03 - Philipp Faller"), ("Tutorium","Philipp"))
     if new_path is not None:
         if new_path.name == "tut2.pdf":
-            return PFERD.rename(new_path, "Tut2.pdf")
+            return rename(new_path, "Tut2.pdf")
 
         return new_path
 
     # Alles Tutoriengedöns von Sebastian in Tutorium/Sebastian/*
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 1"), ("Tutorium","Sebastian", "tut01"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 1"), ("Tutorium","Sebastian", "tut01"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 2", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut02.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 2", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut02.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 3", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut03.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 3", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut03.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 4", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut04.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 4", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut04.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 5", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut05.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 5", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut05.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 6", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut06.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 6", "aufgaben.pdf"), ("Tutorium","Sebastian", "tut06.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 7", "tut7.pdf"), ("Tutorium","Sebastian", "tut07.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 7", "tut7.pdf"), ("Tutorium","Sebastian", "tut07.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 8", "tut8.pdf"), ("Tutorium","Sebastian", "tut08.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 8", "tut8.pdf"), ("Tutorium","Sebastian", "tut08.pdf"))
     if new_path is not None: return new_path
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 9", "tut9.pdf"), ("Tutorium","Sebastian", "tut09.pdf"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 9", "tut9.pdf"), ("Tutorium","Sebastian", "tut09.pdf"))
     if new_path is not None: return new_path
 
     if path.parts == ("Tutorien","Tutorium 23 - Sebastian Faller", "Tutorium 10", "tut10.pdf"): return None
 
-    new_path = PFERD.move(path, ("Tutorien","Tutorium 23 - Sebastian Faller"), ("Tutorium","Sebastian"))
+    new_path = move(path, ("Tutorien","Tutorium 23 - Sebastian Faller"), ("Tutorium","Sebastian"))
     if new_path is not None:
         return new_path
 
     # Übungs-Gedöns in Übung/*
-    new_path = PFERD.move(path, ("Informatikervorlesung", "Übungsfolien"), ("Übung",))
+    new_path = move(path, ("Informatikervorlesung", "Übungsfolien"), ("Übung",))
     if new_path is not None:
         if new_path.name == "Übung_06_ausgewählte Folien.pdf":
-            return PFERD.rename(new_path, "Übung_06_ausgewählte_Folien.pdf")
+            return rename(new_path, "Übung_06_ausgewählte_Folien.pdf")
 
         return new_path
 
     # Vorlesungsfolien-Gedöns in Folien/*
-    new_path = PFERD.move(path, ("Informatikervorlesung", "Folien.Notizen"), ("Folien",))
+    new_path = move(path, ("Informatikervorlesung", "Folien.Notizen"), ("Folien",))
     if new_path is not None:
         return new_path
 
     # Rest in Hauptverzeichnis
-    new_path = PFERD.move(path, ("Informatikervorlesung",), ())
+    new_path = move(path, ("Informatikervorlesung",), ())
     if new_path is not None:
         # Rename filenames that are invalid on FAT systems
         if new_path.name == "Evaluationsergebnisse: Übung.pdf":
-            return PFERD.rename(new_path, "Evaluationsergebnisse_Übung.pdf")
+            return rename(new_path, "Evaluationsergebnisse_Übung.pdf")
         if new_path.name == "Skript \"Lineare Algebra\" von Stefan Kühnlein.pdf":
-            return PFERD.rename(new_path, "Skript Lineare Algebra von Stefan kühnlein.pdf")
+            return rename(new_path, "Skript Lineare Algebra von Stefan kühnlein.pdf")
 
         return new_path
 
@@ -184,24 +184,24 @@ def prog_filter(path):
 
 def prog_transform(path):
     # Übungsblätter in Blätter/*
-    new_path = PFERD.move(path, ("Übungen",), ("Blätter",))
+    new_path = move(path, ("Übungen",), ("Blätter",))
     if new_path is not None:
         if new_path.name == "assignmen04.pdf":
-            return PFERD.rename(new_path, "assignment04.pdf")
+            return rename(new_path, "assignment04.pdf")
 
         return new_path
 
     # Folien in Folien/*
-    new_path = PFERD.move(path, ("Vorlesungsmaterial",), ("Folien",))
+    new_path = move(path, ("Vorlesungsmaterial",), ("Folien",))
     if new_path is not None:
         if new_path.name == "00.1_Begruessung.pdf":
-            return PFERD.rename(new_path, "00-01_Begruessung.pdf")
+            return rename(new_path, "00-01_Begruessung.pdf")
         if new_path.name == "00.2_Organisatorisches.pdf":
-            return PFERD.rename(new_path, "00-02_Organisatorisches.pdf")
+            return rename(new_path, "00-02_Organisatorisches.pdf")
         if new_path.name == "01-01_ Einfache-Programme.pdf":
-            return PFERD.rename(new_path, "01-01_Einfache_Programme.pdf")
+            return rename(new_path, "01-01_Einfache_Programme.pdf")
         if new_path.name == "13_Finden_und_ Beheben_von_Fehlern.pdf":
-            return PFERD.rename(new_path, "13_Finden_und_Beheben_von_Fehlern.pdf")
+            return rename(new_path, "13_Finden_und_Beheben_von_Fehlern.pdf")
 
         return new_path
 
@@ -220,7 +220,7 @@ def algo1_filter(path):
 
 def algo1_transform(path):
     # Folien in Folien/*
-    new_path = PFERD.move(path, ("Vorlesungsfolien",), ("Folien",))
+    new_path = move(path, ("Vorlesungsfolien",), ("Folien",))
     if new_path is not None:
         return new_path
 
@@ -229,15 +229,15 @@ def algo1_transform(path):
 def hm2_transform(path):
     match = re.match(r"blatt(\d+).pdf", path.name)
     if match:
-        new_path = PFERD.move(path, (), ("Blätter",))
+        new_path = move(path, (), ("Blätter",))
         number = int(match.group(1))
-        return PFERD.rename(new_path, f"blatt_{number:02}.pdf")
+        return rename(new_path, f"blatt_{number:02}.pdf")
 
     match = re.match(r"blatt(\d+).loesungen.pdf", path.name)
     if match:
-        new_path = PFERD.move(path, (), ("Blätter",))
+        new_path = move(path, (), ("Blätter",))
         number = int(match.group(1))
-        return PFERD.rename(new_path, f"loesung_{number:02}.pdf")
+        return rename(new_path, f"loesung_{number:02}.pdf")
 
     return path
 
@@ -252,18 +252,18 @@ def la2_filter(path):
 
 def la2_transform(path):
     # Folien in Folien/*
-    new_path = PFERD.move(path, ("Vorlesungsmaterial",), ("Folien",))
+    new_path = move(path, ("Vorlesungsmaterial",), ("Folien",))
     if new_path is not None: return new_path
 
     # Alle Übungsblätter in Blätter/blatt_xx.pdf
     # Alles andere Übungsmaterial in Blätter/*
-    new_path = PFERD.move(path, ("Übungen",), ("Blätter",))
+    new_path = move(path, ("Übungen",), ("Blätter",))
     if new_path is not None:
 
         match = re.match(r"Blatt(\d+).pdf", new_path.name)
         if match:
             number = int(match.group(1))
-            return PFERD.rename(new_path, f"blatt_{number:02}.pdf")
+            return rename(new_path, f"blatt_{number:02}.pdf")
 
         return new_path
 
@@ -280,16 +280,18 @@ def swt1_filter(path):
 
 def swt1_transform(path):
     # Folien in Folien/*
-    new_path = PFERD.move(path, ("Vorlesungsmaterial",), ("Folien",))
+    new_path = move(path, ("Vorlesungsmaterial",), ("Folien",))
     if new_path is not None: return new_path
 
     # Übungsblätter in Blätter/*
-    new_path = PFERD.move(path, ("Übungen",), ("Blätter",))
+    new_path = move(path, ("Übungen",), ("Blätter",))
     if new_path is not None: return new_path
 
     return path
 
-async def main(args):
+# Main part of the config
+
+def main(args):
     args = [arg.lower() for arg in args]
 
     ffm = PFERD.FfM(base_dir)
@@ -298,32 +300,43 @@ async def main(args):
 
     # Semester 1
 
-#    if not args or "gbi" in args:
+    if not args or "gbi" in args:
-#        await ilias.synchronize("855240", "GBI", transform=gbi_transform, filter=gbi_filter)
+        ilias.synchronize("855240", "GBI",
-#    if not args or "hm1" in args:
+                transform=gbi_transform, filter=gbi_filter)
-#        await ffm.synchronize("iana2/lehre/hm1info2018w", "HM1", transform=hm1_transform)
+
-#    if not args or "la1" in args:
+    if not args or "hm1" in args:
-#        await ilias.synchronize("874938", "LA1", transform=la1_transform, filter=la1_filter)
+        ffm.synchronize("iana2/lehre/hm1info2018w", "HM1",
-#    if not args or "prog" in args:
+                transform=hm1_transform)
-#        await ilias.synchronize("851237", "Prog", transform=prog_transform, filter=prog_filter)
+
-#    if not args or "norbert" in args:
+    if not args or "la1" in args:
-#        await norbert.synchronize("Prog-Tut")
+        ilias.synchronize("874938", "LA1",
+                transform=la1_transform, filter=la1_filter)
+
+    if not args or "prog" in args:
+        ilias.synchronize("851237", "Prog",
+                transform=prog_transform, filter=prog_filter)
+
+    if not args or "norbert" in args:
+        norbert.synchronize("Prog-Tut")
 
     # Semester 2
 
     if not args or "algo1" in args:
-        await ilias.synchronize("959260", "Algo1", transform=algo1_transform, filter=algo1_filter)
+        ilias.synchronize("959260", "Algo1",
-    if not args or "hm2" in args:
+                transform=algo1_transform, filter=algo1_filter)
-        await ffm.synchronize("iana2/lehre/hm2info2019s", "HM2", transform=hm2_transform)
-    if not args or "la2" in args:
-        await ilias.synchronize("950588", "LA2", transform=la2_transform, filter=la2_filter)
-    if not args or "swt1" in args:
-        await ilias.synchronize("945596", "SWT1", transform=swt1_transform, filter=swt1_filter)
 
-    await ffm.close()
+    if not args or "hm2" in args:
-    await ilias.close()
+        ffm.synchronize("iana2/lehre/hm2info2019s", "HM2",
-    await norbert.close()
+                transform=hm2_transform)
+
+    if not args or "la2" in args:
+        ilias.synchronize("950588", "LA2",
+                transform=la2_transform, filter=la2_filter)
+
+    if not args or "swt1" in args:
+        ilias.synchronize("945596", "SWT1",
+                transform=swt1_transform, filter=swt1_filter)
 
 if __name__ == "__main__":
     args = sys.argv[1:]
-    asyncio.run(main(args))
+    main(args)

setup.py

@@ -2,7 +2,7 @@ from setuptools import setup
 
 setup(
         name="PFERD",
-        version="0.1.0",
+        version="1.0.0",
         packages=["PFERD"],
         install_requires=[
             "requests>=2.21.0",