Skip to main content

The async fast canavs file syncer.

Project description

Canvas-Syncer

MIT License CodeFactor PyPi Version

An async python script that synchronizes files and folders across Canvas LMS Files and local, with extremely fast speed.

Installation

You may use one of the following

Through Binary

For Windows users, you can find binary(.exe) file here: https://github.com/BoYanZh/Canvas-Syncer/releases. Unzip it and double click canvassyncer.exe file to run, or calling it in shell.

Through pipx

pipx install -U canvassyncer

If you have not installed pipx yet, you may refer to https://pipx.pypa.io/stable/ or the search engine to get your pipx.

From Source

git clone https://github.com/BoYanZh/Canvas-Syncer && cd Canvas-Syncer
pip install -e .

Usage

canvassyncer

Then input the information following the guide.

Note:

  1. courseCode should be something like VG100, ECE4530J
  2. courseID should be an integer. Check the canvas link of the course. e.g. courseID = 7 for https://jicanvas.com/courses/7.

You can use canvassyncer -h to get help.

Optional arguments:

  -h, --help            show this help message and exit
  -r                    recreate config file
  -y                    confirm all prompts
  --no-subfolder        do not create a course code named subfolder when synchronizing files
  -p PATH, --path PATH  appoint config file path
  -c CONNECTION, --connection CONNECTION
                        max connection count with server
  -x PROXY, --proxy PROXY
                        download proxy
  -V, --version         show program's version number and exit
  -d, --debug           show debug information
  --no-keep-older-version
                        do not keep older version

How to get your token?

Open Your Canvas-Account-Approved Integrations-New Access Token

Or it can be easily achieved with https://github.com/BoYanZh/JI-Auth if you are a UM-SJTU-JI student.

Contribution

Please feel free to create issues and pull requests.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

canvassyncer-2.0.12.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

canvassyncer-2.0.12-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file canvassyncer-2.0.12.tar.gz.

File metadata

  • Download URL: canvassyncer-2.0.12.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for canvassyncer-2.0.12.tar.gz
Algorithm Hash digest
SHA256 7d8a8e77854eb1404063814b1bfdbbd4b361413c1fb38f21f6e56f4bd372f7ca
MD5 046889b936f1ad5bb099f48d99904786
BLAKE2b-256 e857d3e789a7bc04684f5c4e9fe0984b59b14bab32a38c42b3e7512ef5e0ea31

See more details on using hashes here.

File details

Details for the file canvassyncer-2.0.12-py3-none-any.whl.

File metadata

File hashes

Hashes for canvassyncer-2.0.12-py3-none-any.whl
Algorithm Hash digest
SHA256 b45b7a01363a042ccc1783b5d474d8e1c90f7e15b479d06e55c61e8cd432c146
MD5 272900c7307b58418fd630d5acd84210
BLAKE2b-256 761dbd6b8483d6902ed7754607e71a8d69fff56dd159dadb7ffc2a69a9692985

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page