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 for integrating the `Open edX Commerce WordPress Plugin`_ with your Open edX instance.
The plugin allows seamless synchronization and interaction between your WordPress site and Open edX platform,
providing a cohesive e-commerce experience. If you don't know how to install the WordPress plugin, check out
this `installation guide`_.
Prerequisites
-------------
- A running WordPress site with the `Open edX Commerce WordPress Plugin`_ installed.
- Installation of Tutor version >= 15.0.0.
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
Configuration
-------------
Inside your WordPress admin panel, you will need to configure the following values:
- **Open edX Domain**
- **Client ID**
- **Client Secret**
.. 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 wordpress config
.. code-block:: text
===============================================
WordPress Plugin Configurations
===============================================
Open edX Domain: http://local.edly.io
Client ID: qjCayDktffXrU09N17NrslKyWQ2EwzWn
Client ID (dev): JDx6Uy0hN67VUfacxKcLyYQz7HK9liVx
Client Secret: P4w82huaZQdyz4qolknsIHYneGEoIggc
Or by using Tutor to print them individually:
.. code-block:: bash
tutor config printvalue LMS_HOST
tutor config printvalue WORDPRESS_OAUTH2_SECRET
tutor config printvalue WORDPRESS_OAUTH2_KEY_SSO
tutor config printvalue WORDPRESS_OAUTH2_KEY_SSO_DEV
Contributing
------------
We welcome all contributions! Feel free to open a Pull Request.
License
-------
This software is licensed under the terms of the `AGPLv3`_.
.. _Tutor: https://docs.tutor.edly.io
.. _installation guide: https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html
.. _Open edX Commerce WordPress Plugin: https://github.com/openedx/openedx-wordpress-ecommerce
.. _AGPLv3: https://github.com/codewithemad/tutor-contrib-wordpress/blob/master/LICENSE.txt
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.8",
"maintainer_email": null,
"keywords": null,
"author": "Emad Rad",
"author_email": "codewithemad@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7b/9b/88a31c9ce2b468866601a9834b50315af02a2a024d84c89958b180045b8e/tutor-contrib-wordpress-1.0.1.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 for integrating the `Open edX Commerce WordPress Plugin`_ with your Open edX instance.\nThe plugin allows seamless synchronization and interaction between your WordPress site and Open edX platform,\nproviding a cohesive e-commerce experience. If you don't know how to install the WordPress plugin, check out\nthis `installation guide`_.\n\nPrerequisites\n-------------\n\n- A running WordPress site with the `Open edX Commerce WordPress Plugin`_ installed.\n- Installation of Tutor version >= 15.0.0.\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\nConfiguration\n-------------\n\nInside your WordPress admin panel, you will need to configure the following values:\n\n- **Open edX Domain**\n- **Client ID**\n- **Client Secret**\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\n\nYou can retrieve these configuration values by running:\n\n.. code-block:: bash\n\n tutor wordpress config\n\n\n.. code-block:: text\n\n ===============================================\n WordPress Plugin Configurations\n ===============================================\n\n Open edX Domain: http://local.edly.io\n Client ID: qjCayDktffXrU09N17NrslKyWQ2EwzWn\n Client ID (dev): JDx6Uy0hN67VUfacxKcLyYQz7HK9liVx\n Client Secret: P4w82huaZQdyz4qolknsIHYneGEoIggc\n\n\nOr by using Tutor to print them individually:\n\n.. code-block:: bash\n\n tutor config printvalue LMS_HOST\n tutor config printvalue WORDPRESS_OAUTH2_SECRET\n tutor config printvalue WORDPRESS_OAUTH2_KEY_SSO\n tutor config printvalue WORDPRESS_OAUTH2_KEY_SSO_DEV\n\nContributing\n------------\n\nWe welcome all contributions! Feel free to open a Pull Request.\n\nLicense\n-------\n\nThis software is licensed under the terms of the `AGPLv3`_.\n\n.. _Tutor: https://docs.tutor.edly.io\n.. _installation guide: https://docs.openedx.org/projects/wordpress-ecommerce-plugin/en/latest/plugin_quickstart.html\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",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Tutor plugin for WooCommerce",
"version": "1.0.1",
"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": "7b9b88a31c9ce2b468866601a9834b50315af02a2a024d84c89958b180045b8e",
"md5": "e1e12e6d53d3e80ddc5b8cf3949b6ba7",
"sha256": "bc01cdfb35011d5e5b61f63b797421972b886067d08c9e05536bbb712c402c01"
},
"downloads": -1,
"filename": "tutor-contrib-wordpress-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "e1e12e6d53d3e80ddc5b8cf3949b6ba7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16893,
"upload_time": "2024-07-27T08:03:17",
"upload_time_iso_8601": "2024-07-27T08:03:17.628047Z",
"url": "https://files.pythonhosted.org/packages/7b/9b/88a31c9ce2b468866601a9834b50315af02a2a024d84c89958b180045b8e/tutor-contrib-wordpress-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-27 08:03:17",
"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
