Metadata-Version: 2.1
Name: cdpDumpingUtils
Version: 0.2.0
Summary: Download all your courses filles from cahier de prepa
Home-page: https://github.com/Azuxul/cahier-de-prepa-downloader
Author: azuxul
License: GPL-3.0
Classifier: Programming Language :: Python :: 3.0
Classifier: Topic :: Utilities
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# cdpDumpingUtils

This project exists to dump files form cahier-de-prepa.fr web site. While some students try to recover every file manually, this tool can export most of the files.

DISCLAIMER : THIS TOOL IS NOT MEANT TO DEFEAT INTELLECTUAL PROPERTY, IT IS JUST A TOOL TO HELP STUDENTS.


## Installation

Install [Python3](https://www.python.org/downloads/) 

- Automatic installation (recommended)

```
pip install cdpDumpingUtils
```

- Manual installation

Download the repository: 

```
git clone https://github.com/Azuxul/cdpDumpingUtils.git
```

Install the dependency:

```
pip install -r requirements.txt
```

Now you can use cdpDumpingUtils but instead of the `cdpDumpingUtils` command you have to use this command: `python cdpDumpingUtils/main.py`

## Usage


```
cdpDumpingUtils -h
```

```
usage: cdpDumpingUtils [-h] [-v] [-l USERNAME] [-p PASSWORD] -o OUTPUT -u URL

options:
  -h, --help            show this help message and exit

arguments optionnels:
  -v, --verbose         Augmente la quantité de texte affiché
  -l USERNAME, --username USERNAME
                        Nom d'utilisateur du compte cahier de prepa (utilisation sans compte possible)
  -p PASSWORD, --password PASSWORD
                        Mot de passe de connexion cahier de prepa

arguments requis:
  -o OUTPUT, --output OUTPUT
                        Chemin d'acces du dossier de sortie
  -u URL, --url URL     URL de l'instance cahier de prepa
```

To run cdpDumpingUtils without an account:
```
cdpDumpingUtils -u https://cahier-de-prepa.fr/XXX/ -o ./output
```

To run cdpDumpingUtils with an account:
```
cdpDumpingUtils -u https://cahier-de-prepa.fr/XXX/ -l username -p password -o ./output
```

## Limitations

This tool may be unusable if cahier-de-prepa is updated. This tool only download documents. Grades, calendars and other features of cahier-de-prepa are not implemented.

## License

This project is licensed under the GNU General Public License v3.0
