Package: canvas-grab
canvas-grabLooking for MaintainersAs I no longer have access to Canvas systems, this project cannot be actively maintained by me. If you are interested in maintaining this project, please email me.Grab all files on Canvas LMS to local directory.Less is More.In canvas_grab v2, we focus on stability and ease of use.
Now you don't have to tweak dozens of configurations. We have a very
simple setup wizard to help you get started!For legacy version, refer tolegacybranch.Getting StartedInstall PythonDownload canvas_grab source code. There are typically three ways of doing this.Go toRelease Pageand download{version}.zip.Orgit clone https://github.com/skyzh/canvas_grab.Use SJTU GitLab, seeRelease Page, or
visithttps://git.sjtu.edu.cn/iskyzh/canvas_grabRun./canvas_grab.sh(Linux, macOS) or.\canvas_grab.ps1(Windows) in Terminal.
Please refer toBuild and Run from Sourcefor more information.Get your API key at Canvas profile and you're ready to go!Please don't modify any file inside download folder (e.g take notes, add supplementary items). They will be overwritten upon each run.You may interrupt the downloading process at any time. The program will automatically resume from where it stopped.To upgrade, just replacecanvas_grabwith a more recent version.If you have any questions, feel free to file an issuehere.Build and Run from SourceFirst of all, please install Python 3.8+, and download source code.We have prepared a simple script to automatically install dependencies and run canvas_grab.For macOS or Linux users, open a Terminal and run:./canvas_grab.shFor Windows users:Right-click Windows icon on taskbar, and select "Run Powershell (Administrator)".RunSet-ExecutionPolicy Unrestrictedin Powershell.If some courses in Canvas LMS have very long module names that exceed Windows limits (which will causes "No such file" error
when downloading), run the following command to enable long path support.Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Control\FileSystem' -Name LongPathsEnabled -Type DWord -Value 1Opencanvas_grabsource file in file browser, Shift + Right-click on blank area, and selectRun Powershell here.Now you can start canvas_grab with a simple command:.\canvas_grab.ps1ConfigureThe setup wizard will automatically create a configuration for you.
You can changeconfig.tomlto fit your needs. If you need to
re-configure, run./configure.shor./configure.ps1.Common IssuesAcquire API tokenAccess Token can be obtained at "Account - Settings - New Access Token".SJTU users请在此页面内通过“创建新访问许可证”按钮生成访问令牌。An error occurredYou'll see "An error occurred when processing this course" if there's no file in a course.File not availableThis file might have been included in an unpublished unit. canvas_grab cannot bypass restrictions.No module named 'canvasapi'You haven't installed the dependencies. Follow steps in "build and run from source" or download prebuilt binaries.Error when checking updateIt's normal if you don't have a stable connection to GitHub. You may regularly check updates by visiting this repo.Reserved escape sequence usedplease use "/" as the path seperator instead of "\".Duplicated files detectedThere're two files of same name in same folder. You should download it from Canvas yourself.ScreenshotContributorsSeeContributorslist.@skyzh,@danyang685are two core maintainers.LicenseMITWhich means that we do not shoulder any responsibilities for, included but not limited to:API key leakingUsers upload copyright material from website to the Internet