{"id":17350571,"url":"https://github.com/codewithemad/tutor-contrib-wordpress","last_synced_at":"2026-03-16T11:37:39.871Z","repository":{"id":250264799,"uuid":"833958194","full_name":"CodeWithEmad/tutor-contrib-wordpress","owner":"CodeWithEmad","description":"Tutor plugin that makes it a bit easier to interact with Open edX Commerce WordPress Plugin","archived":false,"fork":false,"pushed_at":"2025-03-02T05:59:46.000Z","size":189,"stargazers_count":7,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-28T09:36:08.785Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CodeWithEmad.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-07-26T05:59:44.000Z","updated_at":"2025-03-02T05:59:49.000Z","dependencies_parsed_at":"2024-07-26T07:33:14.975Z","dependency_job_id":"bd749619-cf16-4c71-ae26-6256989dedf9","html_url":"https://github.com/CodeWithEmad/tutor-contrib-wordpress","commit_stats":{"total_commits":9,"total_committers":1,"mean_commits":9.0,"dds":0.0,"last_synced_commit":"50a87a75b8c1819556e19877b2692a9e85d78e6d"},"previous_names":["codewithemad/tutor-contrib-wordpress"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithEmad%2Ftutor-contrib-wordpress","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithEmad%2Ftutor-contrib-wordpress/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithEmad%2Ftutor-contrib-wordpress/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CodeWithEmad%2Ftutor-contrib-wordpress/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CodeWithEmad","download_url":"https://codeload.github.com/CodeWithEmad/tutor-contrib-wordpress/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248602301,"owners_count":21131615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-15T17:07:27.989Z","updated_at":"2026-03-16T11:37:39.842Z","avatar_url":"https://github.com/CodeWithEmad.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"WordPress Plugin for `Tutor`_\n#############################\n\n.. image:: https://img.shields.io/pypi/v/tutor-contrib-wordpress?logo=python\u0026logoColor=white\n   :alt: PyPI releases\n   :target: https://pypi.org/project/tutor-contrib-wordpress\n\n.. image:: https://static.pepy.tech/badge/tutor-contrib-wordpress\n   :alt: PyPI Downloads\n   :target: https://pepy.tech/projects/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 \u003e= 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    # or with tutor\n    tutor plugins install 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 -\u003e 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithemad%2Ftutor-contrib-wordpress","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodewithemad%2Ftutor-contrib-wordpress","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodewithemad%2Ftutor-contrib-wordpress/lists"}