A python package which converts a jupyter notebook to a Galvanize Learn challenge
Project description
Jupyter Notebook to Learn Challenge
===============================
julpyter = julia + **Learn** + python + R
version number: 0.0.2
author: Edward Banner
Overview
--------
A python package which provides an nbconvert exporter for converting jupyter notebooks to a Galvanize Learn challenges
Installation / Usage
--------------------
To install use pip:
$ pip install julpyter
Or clone the repo:
$ git clone https://github.com/embanner/julpyter.git
$ python setup.py install
Contributing
------------
TBD
Example
-------
1. Develop your Learn challenge in a jupyter notebook called `050_lr.coding.md.ipynb`
![](examples/images/ipynb.png)
2. Run
```bash
$ jupyter nbconvert --to learn 050_lr.coding.md.ipynb
```
to convert the jupyter notebook to a Learn-style challenge markdown file `050_lr.coding.md`.
![](examples/images/markdown.png)
3. Upload `050_lr.coding.md` to Learn
![](examples/images/learn.png)
See more examples in [`examples/`](examples).
Conventions
-----------
The file name format needs to follow the convention `<name>.<challenge_type>.md.ipynb` where `<challenge_type>` is one of
- coding
- multiple_choice
- number
- paragraph
- raw
julpyter relies on jupyter tags to pull out sections which correspond to sections within Learn challenges.
===============================
julpyter = julia + **Learn** + python + R
version number: 0.0.2
author: Edward Banner
Overview
--------
A python package which provides an nbconvert exporter for converting jupyter notebooks to a Galvanize Learn challenges
Installation / Usage
--------------------
To install use pip:
$ pip install julpyter
Or clone the repo:
$ git clone https://github.com/embanner/julpyter.git
$ python setup.py install
Contributing
------------
TBD
Example
-------
1. Develop your Learn challenge in a jupyter notebook called `050_lr.coding.md.ipynb`
![](examples/images/ipynb.png)
2. Run
```bash
$ jupyter nbconvert --to learn 050_lr.coding.md.ipynb
```
to convert the jupyter notebook to a Learn-style challenge markdown file `050_lr.coding.md`.
![](examples/images/markdown.png)
3. Upload `050_lr.coding.md` to Learn
![](examples/images/learn.png)
See more examples in [`examples/`](examples).
Conventions
-----------
The file name format needs to follow the convention `<name>.<challenge_type>.md.ipynb` where `<challenge_type>` is one of
- coding
- multiple_choice
- number
- paragraph
- raw
julpyter relies on jupyter tags to pull out sections which correspond to sections within Learn challenges.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
julpyter-0.0.2.tar.gz
(4.4 kB
view hashes)