uw-course 1.0.1__tar.gz → 2.0.0__tar.gz

uw_course-2.0.0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: uw-course
+Version: 2.0.0
+Summary: A course helper tool for managing UW courses schedule
+Author-email: Jiucheng Zang <git.jiucheng@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/zangjiucheng/uw-course
+Project-URL: Repository, https://github.com/zangjiucheng/uw-course
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Education
+Classifier: Topic :: Office/Business :: Scheduling
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: attrs
+Requires-Dist: click
+Requires-Dist: PyYAML
+Requires-Dist: reportlab
+Requires-Dist: certifi
+Requires-Dist: dnspython
+Requires-Dist: Pillow
+Requires-Dist: pymongo
+Requires-Dist: textual
+Dynamic: license-file
+
+# uw-course
+
+[![PyPI version](https://badge.fury.io/py/uw-course.svg)](https://badge.fury.io/py/uw-course)
+
+
+This is a project for UWaterloo students to help them get course information and generate a schedule for the next term.
+
+MongoDB DashBoard: [LINK](https://charts.mongodb.com/charts-project-0-cbzai/public/dashboards/091bc68f-76df-48c0-aa69-b21af14c0a8a)
+
+### Example Schedule: 
+
+![Image text](demo.png)
+
+---
+
+### Install Steps: 
+1. Install Python3 (>= 3.10) [Python Website](https://www.python.org/downloads/)
+2. ```bash
+   pip install uw-course
+   ```
+
+---
+
+### Usage (TUI)
+
+Run the terminal UI:
+```bash
+uw-course
+```
+
+You can:
+- Check course details
+- Build a schedule manually or load a plan file
+- View the weekly schedule in the TUI
+- Export the `.out` schedule to PDF
+
+#### Schedule Plan File Format
+1. Create a new file named `schema.txt`
+2. Edit `schema.txt` with the following format:
+```txt
+Class{year}{Winter/Spring/Fall}
+
+{Course}{CourseName}, {ClassID}
+{Course}{CourseName}, {ClassID}
+...
+```
+
+Example:
+```txt
+Class2025Winter
+
+PHYS 234, 7166
+CS 431, 8788
+PMATH 351, 6382
+CO 353, 6157
+STAT 231, 6097
+AMATH 250, 5967
+```
+3. Use the TUI to select “Load Plan” and provide the file path (default: `uw-course-files/schema.txt`).
+4. The program will generate `uw-course-files/schedule.out`, and you can export it to PDF from the TUI.
+
+#### Output Location
+All generated files are stored in `uw-course-files/`:
+- `uw-course-files/schedule.out`
+- `uw-course-files/schedule.pdf`
+- `uw-course-files/schema.txt` (if saved from the TUI)
+
+#### Any Idea or Question, welcome send me an email via: j7zang@uwaterloo.ca
+
+---
+
+## Credits
+
+PDF export uses a modified version of `pdfschedule` by John Thorvald Wodder II. Thanks for the original project.
+
+---
+
+## License
+
+This project is open-source and can be modified and used for personal or educational purposes. Attribution to the original creator is appreciated. (MIT License)

uw_course-2.0.0/README.md

@@ -0,0 +1,80 @@
+# uw-course
+
+[![PyPI version](https://badge.fury.io/py/uw-course.svg)](https://badge.fury.io/py/uw-course)
+
+
+This is a project for UWaterloo students to help them get course information and generate a schedule for the next term.
+
+MongoDB DashBoard: [LINK](https://charts.mongodb.com/charts-project-0-cbzai/public/dashboards/091bc68f-76df-48c0-aa69-b21af14c0a8a)
+
+### Example Schedule: 
+
+![Image text](demo.png)
+
+---
+
+### Install Steps: 
+1. Install Python3 (>= 3.10) [Python Website](https://www.python.org/downloads/)
+2. ```bash
+   pip install uw-course
+   ```
+
+---
+
+### Usage (TUI)
+
+Run the terminal UI:
+```bash
+uw-course
+```
+
+You can:
+- Check course details
+- Build a schedule manually or load a plan file
+- View the weekly schedule in the TUI
+- Export the `.out` schedule to PDF
+
+#### Schedule Plan File Format
+1. Create a new file named `schema.txt`
+2. Edit `schema.txt` with the following format:
+```txt
+Class{year}{Winter/Spring/Fall}
+
+{Course}{CourseName}, {ClassID}
+{Course}{CourseName}, {ClassID}
+...
+```
+
+Example:
+```txt
+Class2025Winter
+
+PHYS 234, 7166
+CS 431, 8788
+PMATH 351, 6382
+CO 353, 6157
+STAT 231, 6097
+AMATH 250, 5967
+```
+3. Use the TUI to select “Load Plan” and provide the file path (default: `uw-course-files/schema.txt`).
+4. The program will generate `uw-course-files/schedule.out`, and you can export it to PDF from the TUI.
+
+#### Output Location
+All generated files are stored in `uw-course-files/`:
+- `uw-course-files/schedule.out`
+- `uw-course-files/schedule.pdf`
+- `uw-course-files/schema.txt` (if saved from the TUI)
+
+#### Any Idea or Question, welcome send me an email via: j7zang@uwaterloo.ca
+
+---
+
+## Credits
+
+PDF export uses a modified version of `pdfschedule` by John Thorvald Wodder II. Thanks for the original project.
+
+---
+
+## License
+
+This project is open-source and can be modified and used for personal or educational purposes. Attribution to the original creator is appreciated. (MIT License)

uw_course-2.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "uw-course"
+version = "2.0.0"
+description = "A course helper tool for managing UW courses schedule"
+authors = [
+    { name = "Jiucheng Zang", email = "git.jiucheng@gmail.com" }
+]
+license = "MIT"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "attrs",
+    "click",
+    "PyYAML",
+    "reportlab",
+    "certifi",
+    "dnspython",
+    "Pillow",
+    "pymongo",
+    "textual"
+]
+classifiers = [
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Education",
+    "Topic :: Office/Business :: Scheduling",
+]
+
+[project.urls]
+Homepage = "https://github.com/zangjiucheng/uw-course"
+Repository = "https://github.com/zangjiucheng/uw-course"
+
+[project.scripts]
+uw-course = "uw_course.main:main"
+
+[tool.pypi]
+repository = "https://pypi.org/project/uw-course"
+github = "zangjiucheng/uw-course"

{uw_course-1.0.1 → uw_course-2.0.0}/uw_course/ClassSchedule/SearchInfo.py

@@ -1,5 +1,4 @@
 import re
-from ..Utiles.colorMessage import *
 
 
 class Course():
@@ -20,7 +19,7 @@ class Course():
             self.courseIndex = course['ClassIndex']
             self.courseTitle = course['classTitle']
             self.courseSeat = course['availableSeat']
-            if re.search("\d:\d*", self.time):
+            if re.search(r"\d:\d*", self.time):
                 self.startTime = self.time[0:5]
                 self.endTime = self.time[6:11]
                 StartTimeFlag = False
@@ -37,7 +36,7 @@ class Course():
                 self.weekDay = "H" if self.time[11:15] == "Th" else self.time[11:15]
                 self.writeSchedule()
             else:
-                print(WARNING + "Z_Z For course %s in class %s, Time Data Error Z_Z" % (self.courseIndex, self.classNum)+ENDC)
+                print("Z_Z For course %s in class %s, Time Data Error Z_Z" % (self.courseIndex, self.classNum))
 
     def writeSchedule(self):
         self.fileOut.write(

{uw_course-1.0.1 → uw_course-2.0.0}/uw_course/ClassSchedule/runner.py

@@ -1,38 +1,49 @@
-from .SearchInfo import Course
-from ..Utiles.randomColor import randomColor, randomGray
-from ..setting import Setting
-from ..Utiles.colorMessage import *
+from uw_course.ClassSchedule.SearchInfo import Course
+from uw_course.Utiles.randomColor import randomColor, randomGray
+from uw_course.setting import Setting
 
 from os import remove
 
 setting = Setting()
 
 
-def SearchCourse(dbClassUW, courseIndex):
+def get_course_detail(dbClassUW, courseIndex):
     CourseDescribe = dbClassUW.CourseDescribe
+    if not courseIndex or " " not in courseIndex:
+        return None
     faculty = courseIndex.split(" ")[0]
     courseNum = courseIndex.split(" ")[1]
     FacultyList = CourseDescribe.find({"faculty": faculty})
     for course in FacultyList:
-        if course["courseIndex"] == courseNum:
-            print("\n" + "$" * 50 + "\n\n")
-            print("Description: ", end="")
-            print(course["courseDescription"])
-            print("\ncourseCredit: ", end="")
-            print(course["courseCredit"])
-            print("\n\n" + "$" * 50)
-            break
+        if course.get("courseIndex") == courseNum:
+            return course
+    return None
+
+
+def SearchCourse(dbClassUW, courseIndex):
+    course = get_course_detail(dbClassUW, courseIndex)
+    if not course:
+        print("@_@ Course %s Not Found @_@" % (courseIndex))
+        return
+    print("\n" + "$" * 50 + "\n\n")
+    print("Description: ", end="")
+    print(course.get("courseDescription"))
+    print("\ncourseCredit: ", end="")
+    print(course.get("courseCredit"))
+    print("\n\n" + "$" * 50)
     print("\n\n")
 
 
-def SearchAvalibleInTerm(dbClassUW, courseIndex, classNum=None):
+def SearchAvalibleInTerm(dbClassUW, courseIndex, classNum=None, quiet=False):
     ClassSchedule = dbClassUW.ClassSchedule
     courseSelect = ClassSchedule.find({"ClassIndex": courseIndex})
     if courseSelect == None:
-        print(FAIL + "@_@ Course %s Not Found in %s @_@" % (courseIndex, dbClassUW.ClassCollectionName) + ENDC)
+        if not quiet:
+            print("@_@ Course %s Not Found in %s @_@" % (courseIndex, dbClassUW.ClassCollectionName))
         return None
     else:
-        print(OKGREEN + "!! Found Course %s in %s !!" % (courseIndex, dbClassUW.ClassCollectionName) + ENDC)
+        if not quiet:
+            print("!! Found Course %s in %s !!" % (courseIndex, dbClassUW.ClassCollectionName))
         if classNum != None:
             return [courseIndex, classNum]
         return [courseIndex]
@@ -41,7 +52,7 @@ def SearchAvalibleInTerm(dbClassUW, courseIndex, classNum=None):
 def makeSchedule(dbClassUW, courseWishList: list, gray: bool=False):
     classSchedule = dbClassUW.ClassSchedule
     if gray:
-        print(OKGREEN + "!! Make Schedule with Gray Color !!" + ENDC)
+        print("!! Make Schedule with Gray Color !!")
     try:
         remove(setting.outDir)
     except:

{uw_course-1.0.1 → uw_course-2.0.0}/uw_course/DB/dbClass.py

@@ -23,3 +23,23 @@ class dbClass:
         self.ClassCollectionName = collectionName
         self.ClassDATABASE.selectCollection(self.ClassCollectionName)
         self.ClassSchedule = self.ClassDATABASE.mongo_collection
+
+    def listClassCollections(self):
+        collections = self.ClassDATABASE.listCollections()
+        term_order = {"Winter": 0, "Spring": 1, "Fall": 2}
+
+        def sort_key(name):
+            if not name.startswith("Class"):
+                return (9999, 99, name)
+            tail = name[len("Class") :]
+            year = tail[:4]
+            term = tail[4:]
+            try:
+                year_value = int(year)
+            except ValueError:
+                year_value = 9999
+            term_value = term_order.get(term, 99)
+            return (year_value, term_value, name)
+
+        class_names = [name for name in collections if name.startswith("Class")]
+        return sorted(class_names, key=sort_key, reverse=True)

{uw_course-1.0.1 → uw_course-2.0.0}/uw_course/Utiles/manageDBClass.py

@@ -16,5 +16,10 @@ class connectDB:
     def selectCollection(self, collection_name):
         self.mongo_collection = self.mongo_db[collection_name]
 
+    def listCollections(self):
+        if self.mongo_db is None:
+            return []
+        return self.mongo_db.list_collection_names()
+
     def closeDB(self):
         self.client.close()

uw_course-2.0.0/uw_course/Utiles/randomColor.py

@@ -0,0 +1,28 @@
+from random import choice
+
+_PALETTE = [
+    "#1F77B4",  # blue
+    "#FF7F0E",  # orange
+    "#2CA02C",  # green
+    "#D62728",  # red
+    "#9467BD",  # purple
+    "#8C564B",  # brown
+    "#E377C2",  # pink
+    "#7F7F7F",  # gray
+    "#BCBD22",  # olive
+    "#17BECF",  # cyan
+    "#4E79A7",  # blue
+    "#F28E2B",  # orange
+    "#59A14F",  # green
+    "#E15759",  # red
+    "#76B7B2",  # teal
+    "#EDC948",  # yellow
+]
+
+
+def randomColor():
+    return choice(_PALETTE)
+
+
+def randomGray():
+    return "#9E9E9E"

uw_course-2.0.0/uw_course/main.py

@@ -0,0 +1,16 @@
+import os
+import sys
+
+if __package__ in (None, ""):
+    sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
+    __package__ = "uw_course"
+
+from uw_course.ui.app import run_app
+
+
+def main():
+    run_app()
+
+
+if __name__ == "__main__":
+    main()