summaryrefslogtreecommitdiff
path: root/README.md
blob: 64c3611d4686bd6ded1094f7a6f5878789253a2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
mongo-edu
=========

[![NPM](https://nodei.co/npm/mongo-edu.png?compact=true)](https://nodei.co/npm/mongo-edu/)

[![NPM version](https://badge.fury.io/js/mongo-edu.png)](http://badge.fury.io/js/mongo-edu)
[![Dependency Status](https://gemnasium.com/przemyslawpluta/mongo-edu.png)](https://gemnasium.com/przemyslawpluta/mongo-edu)

Select and download videos and handouts from [university.mongodb.com](https://university.mongodb.com) courses

## Prerequisite

```
py 2.7 or 3.x
```

## Installation

```
npm install mongo-edu -g
```

or see [detailed installation guide](https://github.com/przemyslawpluta/mongo-edu/wiki/Installation) in the wiki pages

## Usage

```
$ mongo-edu --help

Options:
  -d          download path                             [required]
  -u          email address
  --py        pass switch to point to Python
  --ncc       no check certificate for py3.x < py3.4.x
  --verbose   print debug info

Videos:
  --cw        switch from wiki video lists (default) to courseware
  --cwd       same as --cw and dumps list of videos to file in -d
  --co        sequence video files in order of the courseware
  --cc        get closed captions
  --hq        get high quality videos

Handouts:
  -h          switch from videos (default) to handouts
  --uz        unzip handout files

Proxy:
  --proxy     pass proxy switch for video download
  --test      use with --proxy to test if usable

Presets:
  --save      save presets
  --load      load presets

```

## Select and download

### Videos and closed captions

Download all available videos from lists present in the `wiki` pages for any given week. If no lists are present in `wiki` add `--cw` to search through the main courseware pages.

Add `--cc` to download closed captions with the videos and `--hq` to get high quality videos. Use with `--co` to sequence the video files in order of the wiki ( based on the order of the files present in the wiki lists ) or courseware ( when used with `--cw` preserves the courseware order ).

![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/edu-videos.gif)

### Videos via proxy

You can download videos via proxy tunnel. To test if proxy is usable just pass `--proxy http://proxy_ip_address:proxy_port_number --test` to download a test video via specified proxy. If succesfull just remove `--test` and pass the rest of the required flags.

### Handouts

Add `-h` to download all available handouts present in the `syllabus` pages for any given week and `--uz` to unzip files after the download.

![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/edu-handouts.gif)

## Save / Load presets

You can save presets for use for later. To do so just add `--save my_preset_name` at the end of your call sequence. To recall saved presets just specify `--load ..`.

![screenshot](https://raw.github.com/przemyslawpluta/mongo-edu/gh-pages/images/me-presets.gif)

## License
MIT