WordPress Plugin for `Tutor`_
#############################
.. image:: https://img.shields.io/pypi/v/tutor-contrib-wordpress?logo=python&logoColor=white
:alt: PyPI releases
:target: https://pypi.org/project/tutor-contrib-wordpress
.. image:: https://img.shields.io/github/license/codewithemad/tutor-contrib-wordpress.svg?style=flat-square
:alt: AGPL License
:target: https://www.gnu.org/licenses/agpl-3.0.en.html
Overview
********
This is a `Tutor`_ plugin that provides complete WordPress integration with your Open edX instance. It includes:
- Full WordPress installation and management
- Integration with the `Open edX Commerce WordPress Plugin`_
If you need help installing the WordPress plugin, check out this `installation guide`_.
Prerequisites
*************
- Installation of Tutor version >= 15.0.0
- MySQL database (can use the same one as Open edX)
Installation
************
Ensure you are using Tutor v15+ (Olive onwards). First, install the plugin by running:
.. code-block:: bash
pip install -U tutor-contrib-wordpress
Enable the plugin and run the launch command:
.. code-block:: bash
tutor plugins enable wordpress
tutor dev|local|k8s launch
Alternatively, if you already have a running Open edX instance, just run the necessary jobs:
.. code-block:: bash
tutor dev|local|k8s do init --limit=wordpress
tutor dev|local|k8s start wordpress
Configuration
*************
The plugin automatically installs WordPress with the Open edX Commerce and Woocommerce plugins. Inside your WordPress
admin panel, go to Settings -> Open edX Sync plugin, and configure:
- **Open edX Domain**
- **Client ID**
- **Client Secret**
To verify the connection, click on "Generate JWT Token". If the process is successful, a new token will be generated.
.. image:: https://raw.githubusercontent.com/codewithemad/tutor-contrib-wordpress/master/images/openedx-sync-plugin-settings.png
:alt: Open edX Sync Plugin Settings in your WordPress Settings
You can retrieve these configuration values by running:
.. code-block:: bash
tutor dev|local|k8s do wordpress config
This command will output the current configurations, including the Client ID, Client Secret, Open edX Domain,
and WordPress Domain. Here is an example of the output:
.. code-block:: text
===============================================
WordPress Plugin Configurations
===============================================
Client ID: vvpTamiepPwjZhr0uOQGr5PhYBzp2hQw
Client ID (dev): MlbXk1V3wB7nWPAAyLF3McyfBBMqExa4
Client Secret: MdrgbtU8Q94He3gejF6Zf5MDookoeozO
Open edX Domain: http://local.edly.io:8000
Wordpress Domain: http://site.local.edly.io:8080
Variables
*********
The plugin supports the following configuration variables:
- ``WORDPRESS_VERSION``: Plugin version
- ``WORDPRESS_HOST``: WordPress site hostname
- ``WORDPRESS_PORT``: WordPress port (default: 8080)
- ``WORDPRESS_DOCKER_IMAGE``: Docker image for WordPress
- ``WORDPRESS_OPENEDX_PLUGIN``: URL to the Open edX Commerce plugin
- ``WORDPRESS_WOOCOMMERCE_PLUGIN``: (default: "https://downloads.wordpress.org/plugin/woocommerce.9.4.2.zip")
The WooCommerce plugin zip file URL. You can specify a different version if needed.
- ``WORDPRESS_OFFICIAL_IMAGE``: (default: "wordpress:6.7.1-php8.1")
The official WordPress Docker image used as the base for building the plugin's custom image.
This image includes PHP and Apache server. You can specify a different version or PHP variant if needed.
Database Settings
=================
- ``WORDPRESS_MYSQL_HOST``: MySQL host
- ``WORDPRESS_MYSQL_PORT``: MySQL port
- ``WORDPRESS_MYSQL_DATABASE``: Database name (default: wordpress)
- ``WORDPRESS_MYSQL_USERNAME``: Database username
- ``WORDPRESS_MYSQL_PASSWORD``: Database password (auto-generated)
- ``WORDPRESS_TABLE_PREFIX``: Table prefix (default: ``wp_``)
Storage Settings
================
- ``WORDPRESS_DATA_VOLUME_SIZE``: Size of WordPress persistent volume (default: 5Gi)
OAuth2 Settings
===============
- ``WORDPRESS_OAUTH2_SECRET``: OAuth2 secret key (auto-generated)
- ``WORDPRESS_OAUTH2_KEY_SSO``: OAuth2 client ID (auto-generated)
- ``WORDPRESS_OAUTH2_KEY_SSO_DEV``: OAuth2 development client ID (auto-generated)
Contributing
************
We welcome all contributions! Feel free to open a Pull Request or an Issue.
License
*******
This software is licensed under the terms of the `AGPLv3`_.
.. _Tutor: https://docs.tutor.edly.io
.. _Open edX Commerce WordPress Plugin: https://github.com/openedx/openedx-wordpress-ecommerce
.. _AGPLv3: https://github.com/codewithemad/tutor-contrib-wordpress/blob/master/LICENSE.txt
.. _installation guide: https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html
Raw data
{
"_id": null,
"home_page": "https://github.com/codewithemad/tutor-contrib-wordpress",
"name": "tutor-contrib-wordpress",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Emad Rad",
"author_email": "codewithemad@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e9/b6/77c60bcf049f2a65ade8e3c5b2c5d17674501cd72c1d9c8f7a417e906e48/tutor-contrib-wordpress-1.1.0.tar.gz",
"platform": null,
"description": "WordPress Plugin for `Tutor`_\n#############################\n\n.. image:: https://img.shields.io/pypi/v/tutor-contrib-wordpress?logo=python&logoColor=white\n :alt: PyPI releases\n :target: https://pypi.org/project/tutor-contrib-wordpress\n\n.. image:: https://img.shields.io/github/license/codewithemad/tutor-contrib-wordpress.svg?style=flat-square\n :alt: AGPL License\n :target: https://www.gnu.org/licenses/agpl-3.0.en.html\n\nOverview\n********\n\nThis is a `Tutor`_ plugin that provides complete WordPress integration with your Open edX instance. It includes:\n\n- Full WordPress installation and management\n- Integration with the `Open edX Commerce WordPress Plugin`_\n\nIf you need help installing the WordPress plugin, check out this `installation guide`_.\n\nPrerequisites\n*************\n\n- Installation of Tutor version >= 15.0.0\n- MySQL database (can use the same one as Open edX)\n\nInstallation\n************\n\nEnsure you are using Tutor v15+ (Olive onwards). First, install the plugin by running:\n\n.. code-block:: bash\n\n pip install -U tutor-contrib-wordpress\n\nEnable the plugin and run the launch command:\n\n.. code-block:: bash\n\n tutor plugins enable wordpress\n tutor dev|local|k8s launch\n\nAlternatively, if you already have a running Open edX instance, just run the necessary jobs:\n\n.. code-block:: bash\n\n tutor dev|local|k8s do init --limit=wordpress\n tutor dev|local|k8s start wordpress\n\nConfiguration\n*************\n\nThe plugin automatically installs WordPress with the Open edX Commerce and Woocommerce plugins. Inside your WordPress\nadmin panel, go to Settings -> Open edX Sync plugin, and configure:\n\n- **Open edX Domain**\n- **Client ID**\n- **Client Secret**\n\nTo verify the connection, click on \"Generate JWT Token\". If the process is successful, a new token will be generated.\n\n.. image:: https://raw.githubusercontent.com/codewithemad/tutor-contrib-wordpress/master/images/openedx-sync-plugin-settings.png\n :alt: Open edX Sync Plugin Settings in your WordPress Settings\n\nYou can retrieve these configuration values by running:\n\n.. code-block:: bash\n\n tutor dev|local|k8s do wordpress config\n\nThis command will output the current configurations, including the Client ID, Client Secret, Open edX Domain,\nand WordPress Domain. Here is an example of the output:\n\n.. code-block:: text\n\n ===============================================\n WordPress Plugin Configurations\n ===============================================\n\n Client ID: vvpTamiepPwjZhr0uOQGr5PhYBzp2hQw \n Client ID (dev): MlbXk1V3wB7nWPAAyLF3McyfBBMqExa4 \n Client Secret: MdrgbtU8Q94He3gejF6Zf5MDookoeozO \n\n Open edX Domain: http://local.edly.io:8000 \n Wordpress Domain: http://site.local.edly.io:8080\n\nVariables\n*********\n\nThe plugin supports the following configuration variables:\n\n- ``WORDPRESS_VERSION``: Plugin version\n- ``WORDPRESS_HOST``: WordPress site hostname\n- ``WORDPRESS_PORT``: WordPress port (default: 8080)\n- ``WORDPRESS_DOCKER_IMAGE``: Docker image for WordPress\n- ``WORDPRESS_OPENEDX_PLUGIN``: URL to the Open edX Commerce plugin\n- ``WORDPRESS_WOOCOMMERCE_PLUGIN``: (default: \"https://downloads.wordpress.org/plugin/woocommerce.9.4.2.zip\")\n The WooCommerce plugin zip file URL. You can specify a different version if needed.\n- ``WORDPRESS_OFFICIAL_IMAGE``: (default: \"wordpress:6.7.1-php8.1\")\n The official WordPress Docker image used as the base for building the plugin's custom image.\n This image includes PHP and Apache server. You can specify a different version or PHP variant if needed.\n\nDatabase Settings\n=================\n\n- ``WORDPRESS_MYSQL_HOST``: MySQL host\n- ``WORDPRESS_MYSQL_PORT``: MySQL port\n- ``WORDPRESS_MYSQL_DATABASE``: Database name (default: wordpress)\n- ``WORDPRESS_MYSQL_USERNAME``: Database username\n- ``WORDPRESS_MYSQL_PASSWORD``: Database password (auto-generated)\n- ``WORDPRESS_TABLE_PREFIX``: Table prefix (default: ``wp_``)\n\nStorage Settings\n================\n\n- ``WORDPRESS_DATA_VOLUME_SIZE``: Size of WordPress persistent volume (default: 5Gi)\n\nOAuth2 Settings\n===============\n\n- ``WORDPRESS_OAUTH2_SECRET``: OAuth2 secret key (auto-generated)\n- ``WORDPRESS_OAUTH2_KEY_SSO``: OAuth2 client ID (auto-generated)\n- ``WORDPRESS_OAUTH2_KEY_SSO_DEV``: OAuth2 development client ID (auto-generated)\n\nContributing\n************\n\nWe welcome all contributions! Feel free to open a Pull Request or an Issue.\n\nLicense\n*******\n\nThis software is licensed under the terms of the `AGPLv3`_.\n\n.. _Tutor: https://docs.tutor.edly.io\n.. _Open edX Commerce WordPress Plugin: https://github.com/openedx/openedx-wordpress-ecommerce\n.. _AGPLv3: https://github.com/codewithemad/tutor-contrib-wordpress/blob/master/LICENSE.txt\n.. _installation guide: https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Tutor plugin for WordPress.",
"version": "1.1.0",
"project_urls": {
"Code": "https://github.com/codewithemad/tutor-contrib-wordpress",
"Homepage": "https://github.com/codewithemad/tutor-contrib-wordpress",
"Issue tracker": "https://github.com/codewithemad/tutor-contrib-wordpress/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e9b677c60bcf049f2a65ade8e3c5b2c5d17674501cd72c1d9c8f7a417e906e48",
"md5": "6ec2cb84d32905ba3efd66fd6c2f8da3",
"sha256": "094607fd832ec8b929218257e0e783086e5b4b4074f48f3f3ed36ad229c099ff"
},
"downloads": -1,
"filename": "tutor-contrib-wordpress-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "6ec2cb84d32905ba3efd66fd6c2f8da3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20731,
"upload_time": "2024-12-10T08:52:46",
"upload_time_iso_8601": "2024-12-10T08:52:46.992144Z",
"url": "https://files.pythonhosted.org/packages/e9/b6/77c60bcf049f2a65ade8e3c5b2c5d17674501cd72c1d9c8f7a417e906e48/tutor-contrib-wordpress-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 08:52:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "codewithemad",
"github_project": "tutor-contrib-wordpress",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tutor-contrib-wordpress"
}
JSON
