{ "info": { "author": "David Read", "author_email": "david.read@hackneyworkshop.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Programming Language :: Python :: 2.7" ], "description": ".. You should enable this project on travis-ci.org and coveralls.io to make\n these badges work. The necessary Travis and Coverage config files have been\n generated for you.\n\n.. .. image:: https://travis-ci.org/ckan/ckanext-rq.svg?branch=master\n.. :target: https://travis-ci.org/ckan/ckanext-rq\n\n.. .. image:: https://coveralls.io/repos/ckan/ckanext-rq/badge.svg\n.. :target: https://coveralls.io/r/ckan/ckanext-rq\n\n.. image:: https://pypip.in/download/ckanext-rq/badge.svg\n :target: https://pypi.python.org/pypi//ckanext-rq/\n :alt: Downloads\n\n.. image:: https://pypip.in/version/ckanext-rq/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-rq/\n :alt: Latest Version\n\n.. image:: https://pypip.in/py_versions/ckanext-rq/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-rq/\n :alt: Supported Python versions\n\n.. image:: https://pypip.in/status/ckanext-rq/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-rq/\n :alt: Development Status\n\n.. image:: https://pypip.in/license/ckanext-rq/badge.svg\n :target: https://pypi.python.org/pypi/ckanext-rq/\n :alt: License\n\n=============\nckanext-rq\n=============\n\nBackground jobs functionality for CKAN 2.6 and earlier.\n\nThis is a backport of the background jobs functionality (based on RQ) that was introduced in CKAN 2.7. With this extension, you can make use of RQ based background tasks, on earlier versions of CKAN.\n\nIt is based on the code by @torfsen, mainly here: https://github.com/ckan/ckan/pull/3165\n\nTODO:\n\n* check Redis is available on startup\n* setting ckan.redis.url from environment variable CKAN_REDIS_URL\n\n----\nNote\n----\n\nYou won't be able to use the normal plugin.toolkit.enqueue_job function. Use\nthis import which contains a fallback::\n\n try:\n enqueue_job = p.toolkit.enqueue_job\n except AttributeError:\n from ckanext.rq.jobs import enqueue as enqueue_job\n\n------------\nRequirements\n------------\n\nFor CKAN versions 2.3 to 2.6.x. (Must not be used with CKAN 2.7.0 or later)\n\n------------\nInstallation\n------------\n\nYou need Redis installed::\n\n sudo apt-get install redis-server\n\nTo install ckanext-rq:\n\n1. Activate your CKAN virtual environment, for example::\n\n . /usr/lib/ckan/default/bin/activate\n\n2. Install the ckanext-rq Python package into your virtual environment::\n\n.. pip install ckanext-rq\n pip install git+https://github.com/ckan/ckanext-rq.git\n\n.. 3. Add ``rq`` to the ``ckan.plugins`` setting in your CKAN\n.. config file (by default the config file is located at\n.. ``/etc/ckan/default/production.ini``).\n\n3. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu::\n\n sudo service apache2 reload\n\n4. Start the worker::\n\n paster --plugin=ckanext-rq jobs worker --config=/etc/ckan/default/development.ini\n\n5. To run the worker in a robust way, install and configure Supervisor: http://docs.ckan.org/en/latest/maintaining/background-tasks.html#using-supervisor\n\n---------------\nConfig Settings\n---------------\n\n::\n\n # URL to your Redis instance, including the database to be used.\n ckan.redis.url = redis://localhost:6379/0\n\n\n------------------------\nDevelopment Installation\n------------------------\n\nTo install ckanext-rq for development, activate your CKAN virtualenv and\ndo:\n\n git clone https://github.com/ckan/ckanext-rq.git\n cd ckanext-rq\n python setup.py develop\n pip install -r requirements.txt\n pip install -r dev-requirements.txt\n\n\n-----------------\nRunning the Tests\n-----------------\n\nTo run the tests, do::\n\n nosetests --nologcapture --with-pylons=test.ini\n\nTo run the tests and produce a coverage report, first make sure you have\ncoverage installed in your virtualenv (``pip install coverage``) then run::\n\n nosetests --nologcapture --with-pylons=test.ini --with-coverage --cover-package=ckanext.rq --cover-inclusive --cover-erase --cover-tests\n\n\n----------------------------------------\nReleasing a New Version of ckanext-rq\n----------------------------------------\n\nckanext-rq is availabe on PyPI as https://pypi.python.org/pypi/ckanext-rq.\nTo publish a new version to PyPI follow these steps:\n\n1. Update the version number in the ``setup.py`` file.\n See `PEP 440 `_\n for how to choose version numbers.\n\n2. Create a source distribution of the new version::\n\n python setup.py sdist\n\n3. Upload the source distribution to PyPI::\n\n python setup.py sdist upload\n\n4. Tag the new release of the project on GitHub with the version number from\n the ``setup.py`` file. For example if the version number in ``setup.py`` is\n 0.0.2 then do::\n\n git tag 0.0.2\n git push --tags\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ckan/ckanext-rq", "keywords": "CKAN rq jobs", "license": "AGPL", "maintainer": "", "maintainer_email": "", "name": "ckanext-rq", "package_url": "https://pypi.org/project/ckanext-rq/", "platform": "", "project_url": "https://pypi.org/project/ckanext-rq/", "project_urls": { "Homepage": "https://github.com/ckan/ckanext-rq" }, "release_url": "https://pypi.org/project/ckanext-rq/0.1/", "requires_dist": null, "requires_python": "", "summary": "Background jobs functionality for CKAN 2.6 and earlier", "version": "0.1" }, "last_serial": 3302887, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "e290e82a5c4a4882201fdccb790a8cd9", "sha256": "76a64abb7df6ee7efdf3c042bf9154c9d85b59fef7920cbb8f24fea1082b771e" }, "downloads": -1, "filename": "ckanext-rq-0.1.tar.gz", "has_sig": false, "md5_digest": "e290e82a5c4a4882201fdccb790a8cd9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32280, "upload_time": "2017-11-03T11:23:25", "url": "https://files.pythonhosted.org/packages/66/5a/7ea8a6345993685b885e1449e9eb306f4e5adf1a1bdfe50e9f98efef210d/ckanext-rq-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e290e82a5c4a4882201fdccb790a8cd9", "sha256": "76a64abb7df6ee7efdf3c042bf9154c9d85b59fef7920cbb8f24fea1082b771e" }, "downloads": -1, "filename": "ckanext-rq-0.1.tar.gz", "has_sig": false, "md5_digest": "e290e82a5c4a4882201fdccb790a8cd9", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 32280, "upload_time": "2017-11-03T11:23:25", "url": "https://files.pythonhosted.org/packages/66/5a/7ea8a6345993685b885e1449e9eb306f4e5adf1a1bdfe50e9f98efef210d/ckanext-rq-0.1.tar.gz" } ] }