blackboard-dl

Version, currently master branch1 version
  • master branchlatestJan 20, 2020

github.com/hako/blackboard-dl

📚💻 Downloads lectures and workshops automagically.

10 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  blackboard-dl:
    github: hako/blackboard-dl
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal
no constraint declared
License
MIT
Author
Wesley Hill <wesley@hakobaito.co.uk>

Dependencies

Runtime Dependencies

  • readline*github: crystal-lang/crystal-readline
  • daemonize*github: DougEverly/daemonize.cr

Development Dependencies

  • webmock*github: manastech/webmock.cr, branch: masterdev

README

# blackboard-dl [![Build Status](https://travis-ci.org/hako/blackboard-dl.svg?branch=master)](https://travis-ci.org/hako/blackboard-dl)

A small tool to download lectures and workshops automagically because i'm too lazy to sign in to BlackBoard.

![](demo.gif)

## Requirements
+ [Crystal 0.24.1+](https://crystal-lang.org) 
    +   [Installation Mac/Linux](https://crystal-lang.org) (Sorry Windows users!)
+ Your university must have BlackBoard.

## Install

```
  git clone https://github.com/hako/blackboard-dl
  crystal dep or shards install
  crystal build src/blackboard-dl.cr
  ./blackboard-dl
```

## Usage
```
usage: blackboard-dl [-h] [-d] [-u USERNAME] [-p PASSWORD] [--version]

download course files from blackboard.

optional arguments:
    -u USERNAME, --username          Blackboard username
    -p PASSWORD, --password          Blackboard password
    -d, --daemon                     Run as daemon
    -h, --help                       Show this help
    -v, --version                    Show program version
```

### Examples

##### Auto-login
```
./blackboard-dl -u USERNAME -p PASSWORD
```

##### Auto-login and daemonize
```
./blackboard-dl -d -u USERNAME -p PASSWORD
```

And now watch it download your lectures & workshops in the terminal or in the background.

## Tests

```
crystal dep or shards install
crystal spec
```

## Contributing

1. Fork it ( https://github.com/hako/blackboard-dl/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

## Contributors

- [hako](https://github.com/hako) Wesley Hill - creator, maintainer

### License

MIT