DEPRECATION WARNING
====================
This repository is deprecated and in maintainence-only operation while we work on a replacement, please see `this announcement <https://discuss.openedx.org/t/deprecation-removal-ecommerce-service-depr-22/6839>`__ for more information.
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Although we have stopped integrating new contributions, we always appreciate security disclosures and patches sent to `security@edx.org <mailto:security@edx.org>`__
edX Ecommerce Worker |Build|_ |Codecov|_
=========================================
.. |Build| image:: https://github.com/openedx/ecommerce-worker/workflows/Python%20CI/badge.svg?branch=master
.. _Build: https://github.com/openedx/ecommerce-worker/actions?query=workflow%3A%22Python+CI%22
.. |Codecov| image:: http://codecov.io/github/edx/ecommerce-worker/coverage.svg?branch=master
.. _Codecov: http://codecov.io/github/edx/ecommerce-worker?branch=master
The Celery tasks contained herein are used to implement asynchronous order fulfillment and other features requiring the asynchronous execution of many small, common operations.
Prerequisites
-------------
* Python 3.x
* Celery 4.x
* RabbitMQ 3.5.x
Getting Started
---------------
Most commands necessary to develop and run this app can be found in the included Makefile. These instructions assume a working integration between the `edX ecommerce service <https://github.com/openedx/ecommerce>`_ and the LMS, with asynchronous fulfillment configured on the ecommerce service.
To get started, create a new virtual environment and install the included requirements.
$ make requirements
This project uses `Celery <http://celery.readthedocs.org/en/latest/>`_ to asynchronously execute tasks, such as those required during order fulfillment. Celery requires a solution to send and receive messages which typically comes in the form of a separate service called a message broker. This project uses `RabbitMQ <http://www.rabbitmq.com/>`_ as a message broker. On OS X, use Homebrew to install it.
$ brew install rabbitmq
By default, most operating systems don't allow enough open files for a message broker. RabbitMQ's docs indicate that allowing at least 4096 file descriptors should be sufficient for most development workloads. Check the limit on the number of file descriptors in your current process.
$ ulimit -n
If it needs to be adjusted, run:
$ ulimit -n 4096
Next, start the RabbitMQ server.
$ rabbitmq-server
In a separate process, start the Celery worker.
$ make worker
In a third process, start the ecommerce service. In order for tasks to be visible to the ecommerce worker, the value of Celery's ``BROKER_URL`` setting must shared by the ecommerce service and the ecommerce worker.
Finally, in a fourth process, start the LMS. At this point, if you attempt to enroll in a course supported by the ecommerce service, enrollment will be handled asynchronously by the ecommerce worker.
If you're forced to shut down the Celery workers prematurely, tasks may remain in the queue. To clear them, you can reset RabbitMQ.
$ rabbitmqctl stop_app
$ rabbitmqctl reset
$ rabbitmqctl start_app
License
-------
The code in this repository is licensed under the AGPL unless otherwise noted. Please see ``LICENSE.txt`` for details.
How To Contribute
-----------------
Anyone merging to this repository is expected to `release and monitor their changes <https://openedx.atlassian.net/wiki/spaces/RS/pages/1835106870/How+to+contribute+to+our+repositories>`__; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.
Please also read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`__.
Reporting Security Issues
-------------------------
Please do not report security issues in public. Please email security@edx.org.
Mailing List and IRC Channel
----------------------------
You can discuss this code in the `edx-code Google Group <https://groups.google.com/forum/#!forum/edx-code>`_ or in the ``#edx-code`` IRC channel on Freenode.
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/ecommerce-worker",
"name": "edx-ecommerce-worker",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "edx ecommerce worker",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/e3/33/56acb4ae3a044f93fdf09b0a23c24b70a67d1af0b9f5b71072a4a37cf0b3/edx-ecommerce-worker-3.3.4.tar.gz",
"platform": null,
"description": "DEPRECATION WARNING\n====================\nThis repository is deprecated and in maintainence-only operation while we work on a replacement, please see `this announcement <https://discuss.openedx.org/t/deprecation-removal-ecommerce-service-depr-22/6839>`__ for more information.\n-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------\n\nAlthough we have stopped integrating new contributions, we always appreciate security disclosures and patches sent to `security@edx.org <mailto:security@edx.org>`__\n\nedX Ecommerce Worker |Build|_ |Codecov|_\n=========================================\n.. |Build| image:: https://github.com/openedx/ecommerce-worker/workflows/Python%20CI/badge.svg?branch=master\n.. _Build: https://github.com/openedx/ecommerce-worker/actions?query=workflow%3A%22Python+CI%22\n\n.. |Codecov| image:: http://codecov.io/github/edx/ecommerce-worker/coverage.svg?branch=master\n.. _Codecov: http://codecov.io/github/edx/ecommerce-worker?branch=master\n\nThe Celery tasks contained herein are used to implement asynchronous order fulfillment and other features requiring the asynchronous execution of many small, common operations.\n\nPrerequisites\n-------------\n* Python 3.x\n* Celery 4.x\n* RabbitMQ 3.5.x\n\nGetting Started\n---------------\n\nMost commands necessary to develop and run this app can be found in the included Makefile. These instructions assume a working integration between the `edX ecommerce service <https://github.com/openedx/ecommerce>`_ and the LMS, with asynchronous fulfillment configured on the ecommerce service.\n\nTo get started, create a new virtual environment and install the included requirements.\n\n $ make requirements\n\nThis project uses `Celery <http://celery.readthedocs.org/en/latest/>`_ to asynchronously execute tasks, such as those required during order fulfillment. Celery requires a solution to send and receive messages which typically comes in the form of a separate service called a message broker. This project uses `RabbitMQ <http://www.rabbitmq.com/>`_ as a message broker. On OS X, use Homebrew to install it.\n\n $ brew install rabbitmq\n\nBy default, most operating systems don't allow enough open files for a message broker. RabbitMQ's docs indicate that allowing at least 4096 file descriptors should be sufficient for most development workloads. Check the limit on the number of file descriptors in your current process.\n\n $ ulimit -n\n\nIf it needs to be adjusted, run:\n\n $ ulimit -n 4096\n\nNext, start the RabbitMQ server.\n\n $ rabbitmq-server\n\nIn a separate process, start the Celery worker.\n\n $ make worker\n\nIn a third process, start the ecommerce service. In order for tasks to be visible to the ecommerce worker, the value of Celery's ``BROKER_URL`` setting must shared by the ecommerce service and the ecommerce worker.\n\nFinally, in a fourth process, start the LMS. At this point, if you attempt to enroll in a course supported by the ecommerce service, enrollment will be handled asynchronously by the ecommerce worker.\n\nIf you're forced to shut down the Celery workers prematurely, tasks may remain in the queue. To clear them, you can reset RabbitMQ.\n\n $ rabbitmqctl stop_app\n $ rabbitmqctl reset\n $ rabbitmqctl start_app\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL unless otherwise noted. Please see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nAnyone merging to this repository is expected to `release and monitor their changes <https://openedx.atlassian.net/wiki/spaces/RS/pages/1835106870/How+to+contribute+to+our+repositories>`__; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.\n\nPlease also read `How To Contribute <https://github.com/openedx/.github/blob/master/CONTRIBUTING.md>`__.\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@edx.org.\n\nMailing List and IRC Channel\n----------------------------\n\nYou can discuss this code in the `edx-code Google Group <https://groups.google.com/forum/#!forum/edx-code>`_ or in the ``#edx-code`` IRC channel on Freenode.\n\n\n",
"bugtrack_url": null,
"license": "AGPL",
"summary": "Celery tasks supporting the operations of edX's ecommerce service",
"version": "3.3.4",
"project_urls": {
"Homepage": "https://github.com/openedx/ecommerce-worker"
},
"split_keywords": [
"edx",
"ecommerce",
"worker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "524aa32bd449415352ed1538013989a192a9e5cdcb5f60fa695d1ee2afad0231",
"md5": "00232a81fcb21b87a352bda91984c067",
"sha256": "71e22e90b762e1afb91104a67c961e8051b3757eda22d5a09d402e494f237f41"
},
"downloads": -1,
"filename": "edx_ecommerce_worker-3.3.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "00232a81fcb21b87a352bda91984c067",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 37282,
"upload_time": "2023-06-15T15:38:24",
"upload_time_iso_8601": "2023-06-15T15:38:24.217315Z",
"url": "https://files.pythonhosted.org/packages/52/4a/a32bd449415352ed1538013989a192a9e5cdcb5f60fa695d1ee2afad0231/edx_ecommerce_worker-3.3.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e33356acb4ae3a044f93fdf09b0a23c24b70a67d1af0b9f5b71072a4a37cf0b3",
"md5": "361732e457d20ccf7123e75892dbfbfc",
"sha256": "e1e279b8788b17c24a2f275705863431b71e0b0973d85f8a7843b4da344a9b53"
},
"downloads": -1,
"filename": "edx-ecommerce-worker-3.3.4.tar.gz",
"has_sig": false,
"md5_digest": "361732e457d20ccf7123e75892dbfbfc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 44536,
"upload_time": "2023-06-15T15:38:25",
"upload_time_iso_8601": "2023-06-15T15:38:25.644309Z",
"url": "https://files.pythonhosted.org/packages/e3/33/56acb4ae3a044f93fdf09b0a23c24b70a67d1af0b9f5b71072a4a37cf0b3/edx-ecommerce-worker-3.3.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-15 15:38:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "ecommerce-worker",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "edx-ecommerce-worker"
}
JSON
