{ "info": { "author": "Overhang.io", "author_email": "contact@overhang.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Affero General Public License v3", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "Ecommerce plugin for `Tutor `_\n===============================================================\n\nThis is a plugin for `Tutor `_ that integrates the `Ecommerce `__ application in an Open edX platform.\n\n.. image:: https://overhang.io/images/clients/e-ducation.jpg\n :alt: E-ducation\n :target: https://www.e-ducation.cn/\n\nThis plugin was developed and open sourced to the community thanks to the generous support of `E-ducation `_. Thank you!\n\nInstallation\n------------\n\nThis plugin requires tutor>=3.6.0 and the Discovery plugin `tutor-discovery `__. Also, you should have installed tutor from source, and not from a pre-compiled binary.\n\n::\n\n pip install tutor-ecommerce\n\nThen, to enable this plugin, run::\n\n tutor plugins enable ecommerce\n\nServices will have to be re-configured and restarted, so you are probably better off just running quickstart again::\n\n tutor local quickstart\n\nNote that this plugins is compatible with `Kubernetes integration `__, so if deploying to a Kubernetes cluster, run instead::\n\n tutor k8s quickstart\n\nOperations\n----------\n\nCreating a user\n~~~~~~~~~~~~~~~\n\nThe ecommerce user interface will be available at http://ecommerce.localhost for a local instance, and at ``ECOMMERCE_HOST`` (by default: ``http(s)://ecommerce.``) in production. In order to run commands from the UI, a user with admin rights must be created::\n\n tutor local run ecommerce ./manage.py createsuperuser\n\nLocal development\n~~~~~~~~~~~~~~~~~\n\nFor developing locally, it is necessary to configure the ecommerce service to be served from localhost::\n\n tutor config save --set ECOMMERCE_HOST=ecommerce.localhost\n\nConfiguration\n~~~~~~~~~~~~~\n\n- ``ECOMMERCE_HOST`` (default: ``\"ecommerce.{{ LMS_HOST }}\"``)\n- ``ECOMMERCE_PAYMENT_PROCESSORS`` (default: ``{cybersource: {...}, paypal: {...}}`` See below for details.)\n- ``ECOMMERCE_ENABLED_PAYMENT_PROCESSORS``: (default: ``[\"cybersource\", \"paypal\"]``)\n- ``ECOMMERCE_ENABLED_CLIENT_SIDE_PAYMENT_PROCESSORS`` (default: ``[\"cybersource\"]``)\n- ``ECOMMERCE_EXTRA_PAYMENT_PROCESSOR_CLASSES`` (default: ``[]``)\n- ``ECOMMERCE_MYSQL_PASSWORD``: ``\"{{ 8|random_string }}\"``)\n- ``ECOMMERCE_SECRET_KEY`` (default: ``\"{{ 20|random_string }}\"``)\n- ``ECOMMERCE_OAUTH2_SECRET`` (default: ``\"{{ 8|random_string }}\"``)\n- ``ECOMMERCE_API_KEY`` (default: ``\"{{ 20|random_string }}\"``)\n- ``ECOMMERCE_DOCKER_IMAGE`` (default: ``\"overhangio/openedx-ecommerce:{{ TUTOR_VERSION }}\"``)\n- ``ECOMMERCE_WORKER_DOCKER_IMAGE`` (default: ``\"overhangio/openedx-ecommerce-worker:{{ TUTOR_VERSION }}\"``)\n- ``ECOMMERCE_MYSQL_DATABASE`` (default: ``\"ecommerce\"``)\n- ``ECOMMERCE_MYSQL_USERNAME`` (default: ``\"ecommerce\"``)\n- ``ECOMMERCE_MYSQL_USERNAME`` (default: ``\"ecommerce\"``)\n- ``ECOMMERCE_OAUTH2_KEY`` (default: ``\"ecommerce\"``)\n- ``ECOMMERCE_API_TIMEOUT`` (default: ``5``)\n- ``ECOMMERCE_WORKER_JWT_ISSUER`` (default: ``\"ecommerce_worker\"``)\n- ``ECOMMERCE_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``)\n\nYou will need to modify the ``ECOMMERCE_PAYMENT_PROCESSORS`` parameter to configure your payment providers credentials. By default, it is equal to::\n \n cybersource:\n access_key: SET-ME-PLEASE\n cancel_page_url: /checkout/cancel-checkout/\n merchant_id: SET-ME-PLEASE\n payment_page_url: https://testsecureacceptance.cybersource.com/pay\n profile_id: SET-ME-PLEASE\n receipt_page_url: /checkout/receipt/\n secret_key: SET-ME-PLEASE\n send_level_2_3_details: true\n soap_api_url: https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.140.wsdl\n sop_access_key: SET-ME-PLEASE\n sop_payment_page_url: https://testsecureacceptance.cybersource.com/silent/pay\n sop_profile_id: SET-ME-PLEASE\n sop_secret_key: SET-ME-PLEASE\n transaction_key: SET-ME-PLEASE\n paypal:\n cancel_url: /checkout/cancel-checkout/\n client_id: SET-ME-PLEASE\n client_secret: SET-ME-PLEASE\n error_url: /checkout/error/\n mode: sandbox\n receipt_url: /checkout/receipt/\n \nWe suggest you modify this configuration, save it to ``ecommerce-config.yml`` and then load it with::\n \n tutor config save --set \"ECOMMERCE_PAYMENT_PROCESSORS=$(cat ecommerce-config.yml)\"\n\nImage customisation\n~~~~~~~~~~~~~~~~~~~\n\nEcommerce implementations vary a lot from one country to another. If all you need are the Paypal, Cybersource and Stripe payment processors, then it should not be necessary to customize the tutor-ecommerce docker image, which contains the vanilla Ecommerce platform. However, if you need to run a fork of Ecommerce, or install extra requirements, then you should re-build the docker image. To do so, first set the appropriate settings::\n\n tutor config save \\\n --set 'ECOMMERCE_ENABLED_PAYMENT_PROCESSORS=[\"myprocessor\"]' \\\n --set 'ECOMMERCE_ENABLED_CLIENT_SIDE_PAYMENT_PROCESSORS=[\"myprocessor\"]' \\\n --set 'ECOMMERCE_EXTRA_PAYMENT_PROCESSOR_CLASSES=[\"myextension.payment.MyProcessor\"]' \\\n --set 'ECOMMERCE_EXTRA_PIP_REQUIREMENTS=[\"git+https://github.com/myusername/myplugin\"]'\n\nThen, build the image, pointing to your fork if necessary::\n\n tutor images build ecommerce \\\n -a ECOMMERCE_REPOSITORY=https://github.com/myusername/ecommerce \\\n -a ECOMMERCE_VERSION=my/tag", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://docs.tutor.overhang.io/", "keywords": "", "license": "AGPLv3", "maintainer": "", "maintainer_email": "", "name": "tutor-ecommerce", "package_url": "https://pypi.org/project/tutor-ecommerce/", "platform": "", "project_url": "https://pypi.org/project/tutor-ecommerce/", "project_urls": { "Code": "https://github.com/overhangio/tutor-ecommerce", "Community": "https://discuss.overhang.io", "Documentation": "https://docs.tutor.overhang.io/", "Homepage": "https://docs.tutor.overhang.io/", "Issue tracker": "https://github.com/overhangio/tutor-ecommerce/issues" }, "release_url": "https://pypi.org/project/tutor-ecommerce/0.1.5/", "requires_dist": null, "requires_python": ">=3.5", "summary": "A Tutor plugin for Open edX Ecommerce", "version": "0.1.5" }, "last_serial": 5939167, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "46482e8dc16c0bb5bc6ed307ac4d39f9", "sha256": "bd803393602c7c6063df0b98133afe9fc4951835cbab4213e14dad5d0cc9de7b" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.0.tar.gz", "has_sig": false, "md5_digest": "46482e8dc16c0bb5bc6ed307ac4d39f9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5136, "upload_time": "2019-07-11T06:01:57", "url": "https://files.pythonhosted.org/packages/16/4e/2378f5a4b69eb8daca9da196ca343363ab2e024a5c1ce498868e307850ca/tutor-ecommerce-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "c43f199d6b626414630950d044f875d6", "sha256": "01fc2fefed835b3b030a67569709268221b983df4b66777c291d6699ab6fc5ab" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.1.tar.gz", "has_sig": false, "md5_digest": "c43f199d6b626414630950d044f875d6", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 5646, "upload_time": "2019-07-11T07:21:14", "url": "https://files.pythonhosted.org/packages/95/ce/f0ce3444253187e7ab412901a20fef27c7738e9d0b220e5a9253128ec281/tutor-ecommerce-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "19e876e29f4d4902239053ea8455d33b", "sha256": "d038625d666013c99f815d74e2a46e1ce2b0740a540501dac51aa9faaefd5b0b" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.2.tar.gz", "has_sig": false, "md5_digest": "19e876e29f4d4902239053ea8455d33b", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9073, "upload_time": "2019-07-11T08:56:02", "url": "https://files.pythonhosted.org/packages/04/2b/bd5e1c1550a91f718d2c47a91e01a0c2790b9384e6945906aead0f28966d/tutor-ecommerce-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "f20be2d5c8d3568f5aff13d4f9724f9e", "sha256": "e1dddd75d38f3c93f853f7a7f8df85bcc3f135864ffbf268283b39265c2a8511" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.3.tar.gz", "has_sig": false, "md5_digest": "f20be2d5c8d3568f5aff13d4f9724f9e", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9058, "upload_time": "2019-09-03T09:16:27", "url": "https://files.pythonhosted.org/packages/f5/29/5f318beaf1a5fcb635668b8b79d3d47972e493be12bcf229717e1d6cfa73/tutor-ecommerce-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "7edd934f9ee107e53b5198282c7c75b3", "sha256": "27068656598c52d723ea40d592e33bbadeec09a19dd2d1dfca0764c6d4d9a99d" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.4.tar.gz", "has_sig": false, "md5_digest": "7edd934f9ee107e53b5198282c7c75b3", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9432, "upload_time": "2019-10-03T15:25:09", "url": "https://files.pythonhosted.org/packages/c8/6c/97b0eac69d747ff2be88efb679277560cd58eba22ec8ee4b6e603d62bd63/tutor-ecommerce-0.1.4.tar.gz" } ], "0.1.5": [ { "comment_text": "", "digests": { "md5": "0fc16c682e27d7c43c78b033ed201302", "sha256": "3f1d9202f4ad5eb38c75ca9e0842e92810885dca25b45ec564c4d83dbc5c818c" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.5.tar.gz", "has_sig": false, "md5_digest": "0fc16c682e27d7c43c78b033ed201302", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9478, "upload_time": "2019-10-07T14:41:53", "url": "https://files.pythonhosted.org/packages/93/c5/08f5372f2c698c4aa97b5a0c1c55ff9c53be46ad54ee56d97cd83cb4a777/tutor-ecommerce-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0fc16c682e27d7c43c78b033ed201302", "sha256": "3f1d9202f4ad5eb38c75ca9e0842e92810885dca25b45ec564c4d83dbc5c818c" }, "downloads": -1, "filename": "tutor-ecommerce-0.1.5.tar.gz", "has_sig": false, "md5_digest": "0fc16c682e27d7c43c78b033ed201302", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.5", "size": 9478, "upload_time": "2019-10-07T14:41:53", "url": "https://files.pythonhosted.org/packages/93/c5/08f5372f2c698c4aa97b5a0c1c55ff9c53be46ad54ee56d97cd83cb4a777/tutor-ecommerce-0.1.5.tar.gz" } ] }