canvas-download 1.0.0__tar.gz → 1.1.0__tar.gz

canvas_download-1.1.0/PKG-INFO

@@ -0,0 +1,37 @@
+Metadata-Version: 2.4
+Name: canvas-download
+Version: 1.1.0
+Summary: 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,downloader,offline,sync,utility
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Requires-Dist: canvasapi>=3.3.0
+Requires-Dist: pywin32; platform_system == 'Windows'
+Requires-Dist: tqdm>=4.67.1
+Description-Content-Type: text/markdown
+
+# canvas-download
+canvas-download downloads Canvas modules/files into a local directory for offline access. A file called 'login.json' under the '.config' directory will be created during the first run of the utility, which will require you to fill out the details of your Canvas login credentials. In the second run of the application, '.config/courses.json' will be created by the application and allows you to choose whether to download "files" or "modules" for each course. After those details are filled out, you can simply call 'canvas-download' in the terminal to start the process of downloading files from Canvas.
+
+# How to install
+```
+pip install canvas-download
+```
+# Support
+If you encounter any particular issue with this application, feel free to reach out by opening an issue.

canvas_download-1.1.0/README.md

@@ -0,0 +1,9 @@
+# canvas-download
+canvas-download downloads Canvas modules/files into a local directory for offline access. A file called 'login.json' under the '.config' directory will be created during the first run of the utility, which will require you to fill out the details of your Canvas login credentials. In the second run of the application, '.config/courses.json' will be created by the application and allows you to choose whether to download "files" or "modules" for each course. After those details are filled out, you can simply call 'canvas-download' in the terminal to start the process of downloading files from Canvas.
+
+# How to install
+```
+pip install canvas-download
+```
+# Support
+If you encounter any particular issue with this application, feel free to reach out by opening an issue.

canvas_download-1.1.0/pyproject.toml

@@ -0,0 +1,42 @@
+[build-system]
+requires = ["hatchling >= 1.27"]
+build-backend = "hatchling.build"
+
+[project]
+dependencies = [
+    "canvasapi >= 3.3.0",
+    "tqdm >= 4.67.1",
+    "pywin32; platform_system == 'Windows'"
+]
+name = "canvas-download"
+version = "1.1.0"
+authors = [
+    {name="suncloudsmoon", email="farsaturn@outlook.com"}
+]
+description = "Downloads Canvas modules/files into a local directory."
+keywords = ["canvas", "download", "canvas-grab", "sync", "utility", "downloader", "canvas", "offline"]
+readme="README.md"
+requires-python = ">= 3.10"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Utilities",
+    "Intended Audience :: Education"
+]
+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 → canvas_download-1.1.0}/src/canvas_download/canvas_download.py

@@ -1,25 +1,41 @@
 """
-Create a file called login.json with the following:
-{
-    "API_URL": "",
-    "API_KEY": ""
-}
+canvas-download allows you to download files from canvas with a single command.
 """
 
 import json
 import re
+import sys
 from datetime import datetime, timezone
 from pathlib import Path
 
 from canvasapi import Canvas
 from tqdm import tqdm
 
+if sys.platform == "win32":
+    import win32api
+    import win32con
+
 
 def get_valid_filename(filename: str):
-    return re.sub(r'[<>:"\|\\/\?\*]', " ", filename).strip()
+    return re.sub(r'[<>:"\|\\/\?\*]', " ", filename).strip().strip(".")
+
 
 def main():
-    contents = Path("login.json").read_text(encoding="utf-8")
+    config_dir = Path(".config")
+    login_path = config_dir / "login.json"
+    if not courses_path.exists():
+        courses_path.mkdir()
+        if sys.platform == "win32":
+            win32api.SetFileAttributes(str(config_dir), win32con.FILE_ATTRIBUTE_HIDDEN)
+        
+        contents = json.dumps({"API_URL": "", "API_KEY": ""}, indent=4)
+        login_path.write_text(contents, encoding="utf-8")
+        print(
+            f"Fill out the details of your canvas login credentials at {login_path} and relaunch this application to continue. Note: '.config' directory is hidden."
+        )
+        return
+
+    contents = login_path.read_text(encoding="utf-8")
     login = json.loads(contents)
     canvas = Canvas(login["API_URL"], login["API_KEY"])
 
@@ -34,22 +50,23 @@ def main():
     if not current_courses:
         raise LookupError("no enrolled courses found")
 
-    config_path = Path("config.json")
+    courses_path = config_dir / "courses.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():
+    if not courses_path.exists():
         config = {k: "modules" for k in names_courses}
-        config_path.write_text(json.dumps(config, indent=4), encoding="utf-8")
+        courses_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")
+        contents = courses_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()
+            val.lower() == "modules" or val.lower() == "files"
+            for val in config.values()
         ):
             raise ValueError("invalid config")
 
@@ -80,4 +97,4 @@ def main():
                             continue
                         file_path = folder_path / get_valid_filename(file.display_name)
                         if not file_path.exists():
-                            file.download(str(file_path))
+                            file.download(str(file_path))

canvas_download-1.0.0/PKG-INFO

@@ -1,25 +0,0 @@
-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

@@ -1,8 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-[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"