Skip to content

py-moodle

Getting Started

erseco/python-moodle

py-moodle

erseco/python-moodle

Home
Getting Started
Getting Started
- Getting Started Getting Started
  Table of contents
- Installation
- Configuration
- Quick Start
CLI Reference
API Reference
API Reference
- Core
  Core
  - Session
  - Settings
  - Auth
- Course Management
  Course Management
  - Course
  - Category
  - Section
- Content Modules
  Content Modules
  - Module
  - Label
  - Page
  - Resource
  - Folder
  - URL
  - SCORM
  - Assignment
- File Management
  File Management
  - Upload
  - Draftfile
- User Management
  User Management
  - User
Examples
Development

Getting Started¶

Welcome to py-moodle! This section will help you get up and running quickly.

What is py-moodle?¶

py-moodle is a modern Pythonic CLI and library that allows you to manage Moodle instances via web sessions. It provides both a command-line interface and a Python library for automating Moodle tasks.

Installation - Install py-moodle on your system
Configuration - Set up your Moodle credentials
Quick Start - Your first py-moodle commands

Key Features¶

✅ Session-based authentication - No API tokens required
✅ CAS/SSO support - Works with institutional logins
✅ Rich CLI interface - Beautiful terminal output
✅ Python library - Integrate into your scripts
✅ Multiple content types - Folders, assignments, SCORM, and more

New to Moodle automation?

Start with the Quick Start guide to see py-moodle in action within minutes.