https://github.com/marcocrowe/my-moodle-template

https://github.com/marcocrowe/my-moodle-template

cms college content-management content-management-system file-management jupyter-notebook lecture-notes moodle moodle-downloader my-moodle python python-3 school university

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/marcocrowe/my-moodle-template
• Owner: marcocrowe
• Created: 2024-03-11T16:36:58.000Z (10 months ago)
• Default Branch: master
• Last Pushed: 2024-08-24T10:24:29.000Z (4 months ago)
• Last Synced: 2024-08-24T11:35:52.889Z (4 months ago)
• Topics: cms, college, content-management, content-management-system, file-management, jupyter-notebook, lecture-notes, moodle, moodle-downloader, my-moodle, python, python-3, school, university
• Language: Jupyter Notebook
• Homepage: https://github.com/marcocrowe/my-moodle-template
• Size: 85 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        

# [My Moodle](https://github.com/marcocrowe/my-moodle-template "My Moodle")

This repository is a template for a Python package to download data from Moodle. Press the button below to use this template to create a new repository:

Clone the repository to your local machine:

Replace `USERNAME` with your GitHub username and `COLLEGE-MOODLE` with the name of the repository, i.e. `my-moodle` for mu for 'Maynooth University':

```bash

git clone https://wwww.github.com/USERNAME/COLLEGE-MOODLE.git

```

## Installation

To install the package, run the following command:

```bash

pip install my-moodle

```

You can then open [main.py](main.py) or [notebook-main.ipynb](notebook-main.ipynb) to start the program.

## Description

This package is a Python program to download data from Moodle. The program uses the Moodle API to download data from a Moodle server. The program is designed to download data from a specific course on a Moodle server. The program requires a token to access the Moodle server. The token is a secret key that is generated by the Moodle server.

## Sample Usage

The following is a sample usage of the package:

```python

%pip install my-moodle

from os import getcwd

from my_moodle import ConfigUtility, MoodleDataDownloader

def main() -> None:

    """Main function"""

    MoodleDataDownloader.display_version()

    program, server, token = ConfigUtility.check_and_read_config()

    moodle_data_downloader = MoodleDataDownloader(program, server, token, getcwd())

    moodle_data_downloader.download_my_data()

# Call the main function

if __name__ == "__main__":

    main()

```

## Get Moodle Token

Using  as an example:

1. Open 

2. Copy the key for 'Moodle mobile web service'.

3. The key is saved to a file [config.ini](config.ini)

```ini

[User]

program = Content Management Systems

server = https://moodle.midwest.tus.ie/

token = INSERT_YOUR_TOKEN

```

*Note: The token is a secret key, do not share it with anyone. Usually it is GUID like e.g. **63c1774a3eaf47db816c57ba1abafd40***

---

Copyright © 2024 Mark Crowe . All rights reserved.