canvas-download 1.0.0__tar.gz

canvas_download-1.0.0/.gitignore

@@ -0,0 +1,3 @@
+dist/
+login.json
+config.json

canvas_download-1.0.0/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 suncloudsmoon
+
+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.

canvas_download-1.0.0/PKG-INFO

@@ -0,0 +1,25 @@
+Metadata-Version: 2.4
+Name: canvas-download
+Version: 1.0.0
+Summary: Automatically downloads Canvas modules/files into a local directory.
+Project-URL: Homepage, https://github.com/suncloudsmoon/canvas-download
+Project-URL: Issues, https://github.com/suncloudsmoon/canvas-download/issues
+Author-email: suncloudsmoon <farsaturn@outlook.com>
+License-Expression: MIT
+License-File: LICENSE.txt
+Keywords: canvas,canvas-grab,download
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: canvasapi>=3.3.0
+Requires-Dist: tqdm>=4.67.1
+Description-Content-Type: text/markdown
+
+# canvas-download
+Canvas Download automatically downloads Canvas modules/files into a local directory for offline access. A file called config.json will be created during the first run of the utility and no files will be downloaded in this run. config.json will define whether to download "files" or "modules" for a particular course. To use this command line utility, create the following files as listed below in the same directory as you want the canvas files to be downloaded to.
+
+## login.json
+{
+    "API_URL": "",
+    "API_KEY": ""
+}

canvas_download-1.0.0/README.md

@@ -0,0 +1,8 @@
+# canvas-download
+Canvas Download automatically downloads Canvas modules/files into a local directory for offline access. A file called config.json will be created during the first run of the utility and no files will be downloaded in this run. config.json will define whether to download "files" or "modules" for a particular course. To use this command line utility, create the following files as listed below in the same directory as you want the canvas files to be downloaded to.
+
+## login.json
+{
+    "API_URL": "",
+    "API_KEY": ""
+}

canvas_download-1.0.0/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling >= 1.27"]
+build-backend = "hatchling.build"
+
+[project]
+dependencies = [
+    "canvasapi >= 3.3.0",
+    "tqdm >= 4.67.1"
+]
+name = "canvas-download"
+version = "1.0.0"
+authors = [
+    {name="suncloudsmoon", email="farsaturn@outlook.com"}
+]
+description = "Automatically downloads Canvas modules/files into a local directory."
+keywords = ["canvas", "download", "canvas-grab"]
+readme="README.md"
+requires-python = ">= 3.10"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/suncloudsmoon/canvas-download"
+Issues = "https://github.com/suncloudsmoon/canvas-download/issues"
+
+[project.scripts]
+canvas-download = "canvas_download:main"

canvas_download-1.0.0/src/canvas_download/__init__.py

@@ -0,0 +1 @@
+from .canvas_download import main

canvas_download-1.0.0/src/canvas_download/canvas_download.py

@@ -0,0 +1,83 @@
+"""
+Create a file called login.json with the following:
+{
+    "API_URL": "",
+    "API_KEY": ""
+}
+"""
+
+import json
+import re
+from datetime import datetime, timezone
+from pathlib import Path
+
+from canvasapi import Canvas
+from tqdm import tqdm
+
+
+def get_valid_filename(filename: str):
+    return re.sub(r'[<>:"\|\\/\?\*]', " ", filename).strip()
+
+def main():
+    contents = Path("login.json").read_text(encoding="utf-8")
+    login = json.loads(contents)
+    canvas = Canvas(login["API_URL"], login["API_KEY"])
+
+    courses = canvas.get_courses()
+    current_courses = [
+        course
+        for course in courses
+        if hasattr(course, "end_at_date")
+        and course.end_at_date > datetime.now(tz=timezone.utc)
+    ]
+
+    if not current_courses:
+        raise LookupError("no enrolled courses found")
+
+    config_path = Path("config.json")
+    names_courses = {
+        re.search(r"\w\S+-\S+\w", course.name).group(0).replace("-", " "): course
+        for course in current_courses
+    }
+    if not config_path.exists():
+        config = {k: "modules" for k in names_courses}
+        config_path.write_text(json.dumps(config, indent=4), encoding="utf-8")
+        print("Welcome to canvas sync...")
+        print("config.json has been created; change settings if needed")
+    else:
+        contents = config_path.read_text(encoding="utf-8")
+        config = json.loads(contents)
+        # config validation
+        if not all(name in config for name in names_courses) or not all(
+            val.lower() == "modules" or val.lower() == "files" for val in config.values()
+        ):
+            raise ValueError("invalid config")
+
+        for name, course in tqdm(names_courses.items(), desc="Fetching courses"):
+            course_path = Path(get_valid_filename(name))
+            user_choice = config[name].lower()
+            if user_choice == "modules":
+                for module in course.get_modules():
+                    module_path = course_path / get_valid_filename(module.name)
+                    module_path.mkdir(parents=True, exist_ok=True)
+                    for item in module.get_module_items():
+                        if item.type == "File":
+                            file_path = module_path / get_valid_filename(item.title)
+                            if not file_path.exists():
+                                file = course.get_file(item.content_id)
+                                file.download(str(file_path))
+            elif user_choice == "files":
+                for folder in course.get_folders():
+                    full_path = Path(folder.full_name)
+                    folder_path = (
+                        course_path / full_path.relative_to(full_path.parts[0])
+                        if full_path.parts[0] == "course files"
+                        else None
+                    )
+                    folder_path.mkdir(parents=True, exist_ok=True)
+                    for file in folder.get_files():
+                        if file.locked:
+                            continue
+                        file_path = folder_path / get_valid_filename(file.display_name)
+                        if not file_path.exists():
+                            file.download(str(file_path))