Moodle Development Kit
======================
A collection of tools meant to make developers' lives easier.
Requirements
============
- Linux or Mac OS
- Python 3.6
- MySQL, MariaDB or PostgreSQL
- Git v1.7.7 or greater
Most of the tools work on Moodle 1.9 onwards, but some CLI scripts required by MDK might not be available in all versions.
Usage
=====
The commands are called using that form::
mdk <command> <arguments>
Get some help on a command using::
mdk <command> --help
Also check the `wiki <https://github.com/FMCorz/mdk/wiki>`_.
Installation
============
Python package
--------------
On Debian-based systems, install the following packages::
sudo apt-get install python-pip libmysqlclient-dev libpq-dev python-dev unixodbc-dev
Use `pip <http://www.pip-installer.org/en/latest/installing.html>`_::
pip install moodle-sdk --user
mdk init
Notes
~~~~~
This method does not require ``sudo`` as it installs MDK for the current user. It is assumed that ``~/.local/bin`` is in your PATH (or `equivalent <https://docs.python.org/3/library/site.html#site.USER_BASE>`_).
If it isn't, this snippet for ``~/.profile`` might be useful::
# Set PATH so it includes user's private local bin if it exists.
if [ -d "$HOME/.local/bin" ] ; then
PATH="$HOME/.local/bin:$PATH"
fi
Homebrew
--------
Using `Homebrew <http://brew.sh/>`_, please refer to this `formula <https://github.com/danpoltawski/homebrew-mdk>`_.
For development
---------------
Clone the repository::
git clone https://github.com/FMCorz/mdk.git moodle-sdk
On Debian-based systems, you will need to install the following packages::
sudo apt-get install python-pip libmysqlclient-dev libpq-dev python-dev unixodbc-dev
Then from the directory where you cloned the repository::
python setup.py develop --user
mdk init
Bash completion
~~~~~~~~~~~~~~~
To activate bash completion::
sudo ln -s /path/to/moodle-sdk/extra/bash_completion /etc/bash_completion.d/moodle-sdk
To activate goto commands (``gt`` and ``gtd``), add the following to ~/.bashrc::
if [ -f /path/to/moodle-sdk/extra/goto_instance ]; then
. /path/to/moodle-sdk/extra/goto_instance
. /path/to/moodle-sdk/extra/goto_instance.bash_completion
fi
Upgrading
=========
If you installed MDK using PIP, run the following command::
pip install --user --upgrade moodle-sdk
It is possible that a new version of MDK requires new files, directories, etc... and while we try to make it easy to upgrade, it can happen that some features get broken in your environment. So after each upgrade, consider running the following to get more information::
mdk doctor --all
Command list
============
alias
-----
Set up aliases of your Moodle commands.
**Example**
This line defines the alias 'upall', for 'moodle update --all'
::
mdk alias add upall "update --all"
backport
--------
Backport a branch to another instance of Moodle.
**Examples**
Assuming we are in a Moodle instance, this backports the current branch to the version 2.2 and 2.3
::
mdk backport --version 22 23
Backports the branch MDL-12345-23 from the instance stable_23 to the instance stable_22, and pushes the new branch to your remote
::
mdk backport stable_23 --branch MDL-12345-23 --version 22 --push
backup
------
Backup a whole instance so that it can be restored later.
**Examples**
Backup the instance named stable_master
::
mdk backup stable_master
List the backups
::
mdk backup --list
Restore the second backup of the instance stable_master
::
mdk backup --restore stable_master_02
behat
-----
Get the instance ready for acceptance testing (Behat), and run the test feature(s).
**Examples**
::
mdk behat -r --tags=@core_completion
create
------
Create a new instance of Moodle. It will be named according to your config file.
**Examples**
Create a new instance of Moodle 2.1
::
mdk create --version 21
Create an instance of Moodle 2.2 using PostgreSQL from the integration remote, and run the installation script.
::
mdk create --version 22 --engine pgsql --integration --install
config
------
Set your MDK settings from the command line.
**Examples**
Show the list of your settings
::
mdk config list
Change the value of the setting ``dirs.storage`` to ``/var/www/repositories``
::
mdk config set dirs.storage /var/www/repositories
css
---
CSS related functions.
**Example**
Compile the LESS files from Bootstrapbase
::
mdk css --compile
doctor
------
Perform some checks on the environment to identify possible problems, and attempt to fix them automatically.
fix
---
Create a branch from an issue number on the tracker (MDL-12345) and sets it to track the right branch.
**Examples**
In a Moodle 2.2 instance, this will create (and checkout) a branch named MDL-12345-22 which will track upstream/MOODLE_22_STABLE.
::
mdk fix MDL-12345
mdk fix 12345
info
----
Display information about the instances on the system.
**Examples**
List the instances
::
mdk info --list
Display the information known about the instance *stable_master*
::
mdk info stable_master
install
-------
Run the command line installation script with all parameters set on an existing instance.
**Examples**
::
mdk install --engine mysqli stable_master
js
--
JS related functions.
**Example**
Compile the JS modules in Atto
::
mdk js shift --plugin editor_atto
Generate the complete YUI API documentation
mdk js doc
phpunit
-------
Get the instance ready for PHPUnit tests, and run the test(s).
**Examples**
::
mdk phpunit -u repository/tests/repository_test.php
plugin
------
Look for a plugin on moodle.org and downloads it into your instance.
**Example**
::
mdk plugin download repository_evernote
precheck
--------
Pre-checks a patch on the CI server.
**Example**
::
mdk precheck
purge
-----
Purge the cache.
**Example**
To purge the cache of all the instances
::
mdk purge --all
pull
----
Pulls a patch using the information from a tracker issue.
**Example**
Assuming we type that command on a 2.3 instance, pulls the corresponding patch from the issue MDL-12345 in a testing branch
::
mdk pull --testing 12345
push
----
Shortcut to push a branch to your remote.
**Examples**
Push the current branch to your repository
::
mdk push
Force a push of the branch MDL-12345-22 from the instance stable_22 to your remote
::
mdk push --force --branch MDL-12345-22 stable_22
rebase
------
Fetch the latest branches from the upstream remote and rebase your local branches.
**Examples**
This will rebase the branches MDL-12345-xx and MDL-56789-xx on the instances stable_22, stable_23 and stable_master. And push them to your remote if successful.
::
mdk rebase --issues 12345 56789 --version 22 23 master --push
mdk rebase --issues MDL-12345 MDL-56789 --push stable_22 stable_23 stable_master
remove
------
Remove an instance, deleting every thing including the database.
**Example**
::
mdk remove stable_master
run
---
Execute a script on an instance. The scripts are stored in the scripts directory.
**Example**
Set the instance stable_master ready for development
::
mdk run dev stable_master
tracker
-------
Gets some information about the issue on the tracker.
**Example**
::
$ mdk tracker 34543
------------------------------------------------------------------------
MDL-34543: New assignment module - Feedback file exists for an
assignment but not shown in the Feedback files picker
Bug - Critical - https://tracker.moodle.org/browse/MDL-34543
Closed (Fixed) 2012-08-17 07:25
-------------------------------------------------------[ V: 7 - W: 7 ]--
Reporter : Paul Hague (paulhague) on 2012-07-26 08:30
Assignee : Eric Merrill (emerrill)
Peer reviewer : Damyon Wiese (damyon)
Integrator : Dan Poltawski (poltawski)
Tester : Tim Barker (timb)
------------------------------------------------------------------------
uninstall
---------
Uninstall an instance: removes config file, drops the database, deletes dataroot content, ...
update
------
Fetch the latest stables branches from the upstream remote and pull the changes into the local stable branch.
**Examples**
This updates the instances stable_22 and stable_23
::
mdk update stable_22 stable_23
This updates all your integration instances and runs the upgrade script of Moodle.
::
mdk update --integration --upgrade
upgrade
-------
Run the upgrade script of your instance.
**Examples**
The following runs an upgrade on your stable branches
::
mdk upgrade --stable
This will run an update an each instance before performing the upgrade process
::
mdk upgrade --all --update
Scripts
=======
You can write custom scripts and execute them on your instances using the command ``mdk run``. MDK looks for the scripts in the *scripts* directories and identifies their type by reading their extension. For example, a script called 'helloworld.php' will be executed as a command line script from the root of an installation.
::
# From anywhere on the system
$ mdk run helloworld stable_master
# Is similar to typing the following command
$ cp /path/to/script/helloworld.php /path/to/moodle/instances/stable_master
$ cd /path/to/moodle/instances/stable_master
$ php helloworld.php
Scripts are very handy when it comes to performing more complexed tasks.
Shipped scripts
---------------
The following scripts are available with MDK:
* ``dev``: Changes a portion of Moodle settings to enable development mode
* ``enrol``: Enrols users in any existing course
* ``external_functions``: Refreshes the definitions of services and external functions
* ``makecourse``: Creates a test course
* ``mindev``: Minimalist set of development settings (performance friendly)
* ``setup``: Setup for development by running a succession of other scripts
* ``tokens``: Lists the webservice tokens
* ``undev``: Reverts the changes made by ``dev`` and ``mindev``
* ``users``: Creates a set of users
* ``version``: Fixes downgrade version conflicts
* ``webservices``: Does all the set up of webservices for you
License
=======
Licensed under the `GNU GPL License <http://www.gnu.org/copyleft/gpl.html>`_
Raw data
{
"_id": null,
"home_page": "https://github.com/FMCorz/mdk",
"name": "moodle-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "mdk moodle moodle-sdk",
"author": "Fr\u00e9d\u00e9ric Massart",
"author_email": "fred@fmcorz.net",
"download_url": "https://files.pythonhosted.org/packages/d3/a8/6dcc68e1226de224a9cfd17b91687829047bfa9f2f0eb1172d50e674ebec/moodle_sdk-2.0.14.tar.gz",
"platform": null,
"description": "Moodle Development Kit\n======================\n\nA collection of tools meant to make developers' lives easier.\n\nRequirements\n============\n\n- Linux or Mac OS\n- Python 3.6\n- MySQL, MariaDB or PostgreSQL\n- Git v1.7.7 or greater\n\nMost of the tools work on Moodle 1.9 onwards, but some CLI scripts required by MDK might not be available in all versions.\n\nUsage\n=====\n\nThe commands are called using that form::\n\n mdk <command> <arguments>\n\nGet some help on a command using::\n\n mdk <command> --help\n\nAlso check the `wiki <https://github.com/FMCorz/mdk/wiki>`_.\n\nInstallation\n============\n\nPython package\n--------------\n\nOn Debian-based systems, install the following packages::\n\n sudo apt-get install python-pip libmysqlclient-dev libpq-dev python-dev unixodbc-dev\n\nUse `pip <http://www.pip-installer.org/en/latest/installing.html>`_::\n\n pip install moodle-sdk --user\n mdk init\n\nNotes\n~~~~~\n\nThis method does not require ``sudo`` as it installs MDK for the current user. It is assumed that ``~/.local/bin`` is in your PATH (or `equivalent <https://docs.python.org/3/library/site.html#site.USER_BASE>`_).\n\nIf it isn't, this snippet for ``~/.profile`` might be useful::\n\n # Set PATH so it includes user's private local bin if it exists.\n if [ -d \"$HOME/.local/bin\" ] ; then\n PATH=\"$HOME/.local/bin:$PATH\"\n fi\n\nHomebrew\n--------\n\nUsing `Homebrew <http://brew.sh/>`_, please refer to this `formula <https://github.com/danpoltawski/homebrew-mdk>`_.\n\n\nFor development\n---------------\n\nClone the repository::\n\n git clone https://github.com/FMCorz/mdk.git moodle-sdk\n\nOn Debian-based systems, you will need to install the following packages::\n\n sudo apt-get install python-pip libmysqlclient-dev libpq-dev python-dev unixodbc-dev\n\nThen from the directory where you cloned the repository::\n\n python setup.py develop --user\n mdk init\n\n\nBash completion\n~~~~~~~~~~~~~~~\n\nTo activate bash completion::\n\n sudo ln -s /path/to/moodle-sdk/extra/bash_completion /etc/bash_completion.d/moodle-sdk\n\nTo activate goto commands (``gt`` and ``gtd``), add the following to ~/.bashrc::\n\n if [ -f /path/to/moodle-sdk/extra/goto_instance ]; then\n . /path/to/moodle-sdk/extra/goto_instance\n . /path/to/moodle-sdk/extra/goto_instance.bash_completion\n fi\n\n\nUpgrading\n=========\n\nIf you installed MDK using PIP, run the following command::\n\n pip install --user --upgrade moodle-sdk\n\nIt is possible that a new version of MDK requires new files, directories, etc... and while we try to make it easy to upgrade, it can happen that some features get broken in your environment. So after each upgrade, consider running the following to get more information::\n\n mdk doctor --all\n\n\nCommand list\n============\n\nalias\n-----\n\nSet up aliases of your Moodle commands.\n\n**Example**\n\nThis line defines the alias 'upall', for 'moodle update --all'\n\n::\n\n mdk alias add upall \"update --all\"\n\nbackport\n--------\n\nBackport a branch to another instance of Moodle.\n\n**Examples**\n\nAssuming we are in a Moodle instance, this backports the current branch to the version 2.2 and 2.3\n\n::\n\n mdk backport --version 22 23\n\nBackports the branch MDL-12345-23 from the instance stable_23 to the instance stable_22, and pushes the new branch to your remote\n\n::\n\n mdk backport stable_23 --branch MDL-12345-23 --version 22 --push\n\nbackup\n------\n\nBackup a whole instance so that it can be restored later.\n\n**Examples**\n\nBackup the instance named stable_master\n\n::\n\n mdk backup stable_master\n\nList the backups\n\n::\n\n mdk backup --list\n\nRestore the second backup of the instance stable_master\n\n::\n\n mdk backup --restore stable_master_02\n\n\nbehat\n-----\n\nGet the instance ready for acceptance testing (Behat), and run the test feature(s).\n\n**Examples**\n\n::\n\n mdk behat -r --tags=@core_completion\n\n\ncreate\n------\n\nCreate a new instance of Moodle. It will be named according to your config file.\n\n**Examples**\n\nCreate a new instance of Moodle 2.1\n\n::\n\n mdk create --version 21\n\nCreate an instance of Moodle 2.2 using PostgreSQL from the integration remote, and run the installation script.\n\n::\n\n mdk create --version 22 --engine pgsql --integration --install\n\nconfig\n------\n\nSet your MDK settings from the command line.\n\n**Examples**\n\nShow the list of your settings\n\n::\n\n mdk config list\n\nChange the value of the setting ``dirs.storage`` to ``/var/www/repositories``\n\n::\n\n mdk config set dirs.storage /var/www/repositories\n\n\ncss\n---\n\nCSS related functions.\n\n**Example**\n\nCompile the LESS files from Bootstrapbase\n\n::\n\n mdk css --compile\n\n\ndoctor\n------\n\nPerform some checks on the environment to identify possible problems, and attempt to fix them automatically.\n\n\nfix\n---\n\nCreate a branch from an issue number on the tracker (MDL-12345) and sets it to track the right branch.\n\n**Examples**\n\nIn a Moodle 2.2 instance, this will create (and checkout) a branch named MDL-12345-22 which will track upstream/MOODLE_22_STABLE.\n\n::\n\n mdk fix MDL-12345\n mdk fix 12345\n\n\ninfo\n----\n\nDisplay information about the instances on the system.\n\n**Examples**\n\nList the instances\n\n::\n\n mdk info --list\n\nDisplay the information known about the instance *stable_master*\n\n::\n\n mdk info stable_master\n\n\ninstall\n-------\n\nRun the command line installation script with all parameters set on an existing instance.\n\n**Examples**\n\n::\n\n mdk install --engine mysqli stable_master\n\n\njs\n--\n\nJS related functions.\n\n**Example**\n\nCompile the JS modules in Atto\n\n::\n\n mdk js shift --plugin editor_atto\n\n\nGenerate the complete YUI API documentation\n\n mdk js doc\n\n\nphpunit\n-------\n\nGet the instance ready for PHPUnit tests, and run the test(s).\n\n**Examples**\n\n::\n\n mdk phpunit -u repository/tests/repository_test.php\n\n\nplugin\n------\n\nLook for a plugin on moodle.org and downloads it into your instance.\n\n**Example**\n\n::\n\n mdk plugin download repository_evernote\n\n\nprecheck\n--------\n\nPre-checks a patch on the CI server.\n\n**Example**\n\n::\n\n mdk precheck\n\n\npurge\n-----\n\nPurge the cache.\n\n**Example**\n\nTo purge the cache of all the instances\n\n::\n\n mdk purge --all\n\n\npull\n----\n\nPulls a patch using the information from a tracker issue.\n\n**Example**\n\nAssuming we type that command on a 2.3 instance, pulls the corresponding patch from the issue MDL-12345 in a testing branch\n\n::\n\n mdk pull --testing 12345\n\n\npush\n----\n\nShortcut to push a branch to your remote.\n\n**Examples**\n\nPush the current branch to your repository\n\n::\n\n mdk push\n\nForce a push of the branch MDL-12345-22 from the instance stable_22 to your remote\n\n::\n\n mdk push --force --branch MDL-12345-22 stable_22\n\n\nrebase\n------\n\nFetch the latest branches from the upstream remote and rebase your local branches.\n\n**Examples**\n\nThis will rebase the branches MDL-12345-xx and MDL-56789-xx on the instances stable_22, stable_23 and stable_master. And push them to your remote if successful.\n\n::\n\n mdk rebase --issues 12345 56789 --version 22 23 master --push\n mdk rebase --issues MDL-12345 MDL-56789 --push stable_22 stable_23 stable_master\n\n\nremove\n------\n\nRemove an instance, deleting every thing including the database.\n\n**Example**\n\n::\n\n mdk remove stable_master\n\n\nrun\n---\n\nExecute a script on an instance. The scripts are stored in the scripts directory.\n\n**Example**\n\nSet the instance stable_master ready for development\n\n::\n\n mdk run dev stable_master\n\n\ntracker\n-------\n\nGets some information about the issue on the tracker.\n\n**Example**\n\n::\n\n $ mdk tracker 34543\n ------------------------------------------------------------------------\n MDL-34543: New assignment module - Feedback file exists for an\n assignment but not shown in the Feedback files picker\n Bug - Critical - https://tracker.moodle.org/browse/MDL-34543\n Closed (Fixed) 2012-08-17 07:25\n -------------------------------------------------------[ V: 7 - W: 7 ]--\n Reporter : Paul Hague (paulhague) on 2012-07-26 08:30\n Assignee : Eric Merrill (emerrill)\n Peer reviewer : Damyon Wiese (damyon)\n Integrator : Dan Poltawski (poltawski)\n Tester : Tim Barker (timb)\n ------------------------------------------------------------------------\n\n\nuninstall\n---------\n\nUninstall an instance: removes config file, drops the database, deletes dataroot content, ...\n\n\nupdate\n------\n\nFetch the latest stables branches from the upstream remote and pull the changes into the local stable branch.\n\n**Examples**\n\nThis updates the instances stable_22 and stable_23\n\n::\n\n mdk update stable_22 stable_23\n\nThis updates all your integration instances and runs the upgrade script of Moodle.\n\n::\n\n mdk update --integration --upgrade\n\n\nupgrade\n-------\n\nRun the upgrade script of your instance.\n\n**Examples**\n\nThe following runs an upgrade on your stable branches\n\n::\n\n mdk upgrade --stable\n\nThis will run an update an each instance before performing the upgrade process\n\n::\n\n mdk upgrade --all --update\n\nScripts\n=======\n\nYou can write custom scripts and execute them on your instances using the command ``mdk run``. MDK looks for the scripts in the *scripts* directories and identifies their type by reading their extension. For example, a script called 'helloworld.php' will be executed as a command line script from the root of an installation.\n\n::\n\n # From anywhere on the system\n $ mdk run helloworld stable_master\n\n # Is similar to typing the following command\n $ cp /path/to/script/helloworld.php /path/to/moodle/instances/stable_master\n $ cd /path/to/moodle/instances/stable_master\n $ php helloworld.php\n\nScripts are very handy when it comes to performing more complexed tasks.\n\nShipped scripts\n---------------\n\nThe following scripts are available with MDK:\n\n* ``dev``: Changes a portion of Moodle settings to enable development mode\n* ``enrol``: Enrols users in any existing course\n* ``external_functions``: Refreshes the definitions of services and external functions\n* ``makecourse``: Creates a test course\n* ``mindev``: Minimalist set of development settings (performance friendly)\n* ``setup``: Setup for development by running a succession of other scripts\n* ``tokens``: Lists the webservice tokens\n* ``undev``: Reverts the changes made by ``dev`` and ``mindev``\n* ``users``: Creates a set of users\n* ``version``: Fixes downgrade version conflicts\n* ``webservices``: Does all the set up of webservices for you\n\nLicense\n=======\n\nLicensed under the `GNU GPL License <http://www.gnu.org/copyleft/gpl.html>`_\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Moodle Development Kit",
"version": "2.0.14",
"project_urls": {
"Homepage": "https://github.com/FMCorz/mdk"
},
"split_keywords": [
"mdk",
"moodle",
"moodle-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98fccbd3811b9048942db7900203d00273d6c1ece9fca042ae4eb02bf0318596",
"md5": "3b59b63eb6c836e44a26d76d24a981d8",
"sha256": "82524d0357bc16f29e347bfd50fc0dc00ebd19ef6d6a67f48b073b463f10481f"
},
"downloads": -1,
"filename": "moodle_sdk-2.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b59b63eb6c836e44a26d76d24a981d8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 147722,
"upload_time": "2024-04-22T08:13:51",
"upload_time_iso_8601": "2024-04-22T08:13:51.858204Z",
"url": "https://files.pythonhosted.org/packages/98/fc/cbd3811b9048942db7900203d00273d6c1ece9fca042ae4eb02bf0318596/moodle_sdk-2.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d3a86dcc68e1226de224a9cfd17b91687829047bfa9f2f0eb1172d50e674ebec",
"md5": "fbecf5d6a61418f36c678873644603ff",
"sha256": "626cd49a51335a2592290f98e3533b27d26b08d3fac637d16efd72b7e9d87e96"
},
"downloads": -1,
"filename": "moodle_sdk-2.0.14.tar.gz",
"has_sig": false,
"md5_digest": "fbecf5d6a61418f36c678873644603ff",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 111472,
"upload_time": "2024-04-22T08:13:58",
"upload_time_iso_8601": "2024-04-22T08:13:58.635467Z",
"url": "https://files.pythonhosted.org/packages/d3/a8/6dcc68e1226de224a9cfd17b91687829047bfa9f2f0eb1172d50e674ebec/moodle_sdk-2.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-22 08:13:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "FMCorz",
"github_project": "mdk",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "moodle-sdk"
}
JSON
