Metadata-Version: 2.1
Name: caex2
Version: 0.1.1
Summary: Automatically extract all exercises from a carpentries lesson.
Home-page: https://github.com/esciencecenter-digital-skills/carpentries-exercises-extractor
Author: 
Sven van der Burg
Dafne van Kuppevelt
Author-email: s.vanderburg@esciencecenter.nl
Keywords: Extract,Exercises
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Carpentries Instructors
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Provides-Extra: publishing
License-File: LICENSE

# CaEx2 (CArpentries EXercises EXtractor)
## What does it do?
No more copy-pasting, automatically extract all exercises from a carpentries lesson.

## How to install?
Install with pip:
```
pip install caex2
```

## How to use?
```commandline
caex2 {LESSON_URL} --output {OPTIONAL_OUTPUT_FILE}
```

### Example
To extract all exercises from the [deep learning lesson](https://github.com/carpentries-incubator/deep-learning-intro):
```commandline
caex2 https://github.com/carpentries-incubator/deep-learning-intro
```
This creates a new file called `exercises-document.md` with all exercises in the lesson,
grouped and ordered by episode.

## Current support
This package currently supports carpentries lessons in the 'old' style, it has been tested on:
* https://github.com/carpentries-incubator/deep-learning-intro
* https://github.com/datacarpentry/r-socialsci (episodes are in Rmarkdown)
* https://github.com/datacarpentry/python-socialsci
