Git Product home page Git Product logo

canvas-bot's Introduction

Canvas command line client.

A easy to use canvas command line client.

Features:

  • Synchronize canvas courses files to local directory.
  • Incremental download and.
  • Query canvas user, courses, and group information.
  • Submit assignment.
  • Upload Files to canvas user folder.

Install

npm install -g canvas-spider

How to use

To use this client you need a yaml config file specifies your canvas token, url and some program behavior an example config file can be found on config-demo.yaml. You can also generate a config file template with canvasBot template [,-options] command. About how to generate a canvas token please read this. Make sure you don't share your token, or invalidate the token immediately once you leak the token for some reasons.

Demo

asciicast

Command line autocomplete

Run the following command

canvasBot autocomplete on -s <your shell config file>

This will add a autocomplete shell script into your shell config. To remove the autocomplete feature simly remove the corresponding shell scirpt. More information on here;

Get help

Run local canvasBot [command] --help to get more help on each sub commands.


                                      _           _
                                      | |         | |
   ___ __ _ _ ____   ____ _ ___ ______| |__   ___ | |_
  / __/ _` | '_ \ \ / / _` / __|______| '_ \ / _ \| __|
 | (_| (_| | | | \ V / (_| \__ \      | |_) | (_) | |_
  \___\__,_|_| |_|\_/ \__,_|___/      |_.__/ \___/ \__|


Commands:
  canvasBot template              generate yaml template
  canvasBot courses               show all courses
  canvasBot user                  show user info
  canvasBot quota                 show storage quota on canvas
  canvasBot download [yaml]       download files with given yaml config
  canvasBot autocomplete [onoff]  turn on/off autocomplete

Options:
  --help, -h     Show help                                             [boolean]
  --version, -v  Show version number                                   [boolean]

more information from https://github.com/ailrk/canvas-bot

Please don't share your token!

LICENSE

MIT

canvas-bot's People

Contributors

ailrk avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.