Skip to main content

Python wrapper for moodle web service.

Project description

moodlepy

PyPi Package Version ![Supported Python versions](https://img.shields.io/pypi/pyversions/moodlepy LICENSE Tests codecov pre-commit Mypy

Python wrapper for moodle web service.

Introduction

This library provide a pure Python interface for Moodle Web Service. It's compatible with Python versions 3.6+

Installing

You can install or upgrade moodlepy with:

pip install moodlepy --upgrade

Or you can install from source with:

git clone https://github.com/hexatester/moodlepy
cd moodlepy
python setup.py install

Usage

Example usage

from moodle import Moodle
url = 'https://my.domain/webservice/rest/server.php'
token = 'super secret token'
moodle = Moodle(url, token)
raw_site_info = moodle('core_webservice_get_site_info')
site_info = moodle.core.webservice.get_site_info()  # return typed site_info

print(raw_site_info)
print(site_info)

# or
from moodle import Mdl
from moodle.core.webservice import BaseWebservice

moodle = Mdl(url, token)
webservice = BaseWebservice(moodle)
site_info2 = webservice.get_site_info()

assert site_info == site_info2

In the future all Web service functions will be covered by moodlepy

Moodle Web Service support

❗️ Not all types and methods are supported, since moodlepy is not yet released. (A = Added.)

Area Functions Types Tests Status
auth_email A A
block A A
core_auth A A
core_backup A A
core_badge A A A
core_blog A A A
core_calendar A A
core_cohort
core_comment
core_competency
core_completion A A
core_course
core_customfield A A
core_enrol
core_fetch
core_files
core_filters
core_form
core_get
core_grade
core_grades
core_grading
core_group
core_h5p
core_message A
core_notes A A
core_output
core_question
core_rating
core_role
core_search
core_session
core_tag
core_update
core_user
core_webservice A A A A
enrol_guest A A
enrol_manual A A
enrol_self A A
gradereport_overview
gradereport_user
gradingform_guide
gradingform_rubric
local_mobile
message_airnotifier
message_popup
mod_assign
mod_book
mod_chat A
mod_choice
mod_data A
mod_feedback
mod_folder A A
mod_forum
mod_glossary
mod_imscp
mod_label
mod_lesson
mod_lti
mod_page A A
mod_quiz
mod_resource A A
mod_scorm
mod_survey
mod_url A A
mod_wiki
mod_workshop A
report_competency
report_insights
tool_analytics
tool_lp
tool_mobile A A
tool_templatelibrary
tool_usertours
tool_xmldb

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

moodlepy-0.22.0.tar.gz (76.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moodlepy-0.22.0-py3-none-any.whl (136.2 kB view details)

Uploaded Python 3

File details

Details for the file moodlepy-0.22.0.tar.gz.

File metadata

  • Download URL: moodlepy-0.22.0.tar.gz
  • Upload date:
  • Size: 76.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.8 Windows/10

File hashes

Hashes for moodlepy-0.22.0.tar.gz
Algorithm Hash digest
SHA256 7fddbbe5b9f799bdc4e32ed16718b4239063af3d531365ffc4878980c6d72b98
MD5 728944d048091d188637dbf0965ce851
BLAKE2b-256 8e4be80f1f7e30e1cba40fd9b3a7dcedbdb161b738a734a1de9a895148a3d91c

See more details on using hashes here.

File details

Details for the file moodlepy-0.22.0-py3-none-any.whl.

File metadata

  • Download URL: moodlepy-0.22.0-py3-none-any.whl
  • Upload date:
  • Size: 136.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.7.8 Windows/10

File hashes

Hashes for moodlepy-0.22.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7ea2aaa226a9350d37ae5e37b648f86f5d0a1ae642ddb1d952df9d46581e6b9c
MD5 0f2e321e3a5f21395456c0bf389c2192
BLAKE2b-256 e8d8e3f946e2f93481bc5b45ae61df87b76035a9bbd1844b0e6b5fe865ad6f1f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page