{ "info": { "author": "Chad Shryock", "author_email": "chad@isl.co", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Web Environment", "Framework :: Django", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 2.7" ], "description": "# Django RQ Scheduler\n\nA database backed job scheduler for Django RQ.\n\n## Requirements\n\nCurrently, when you pip install Django RQ Scheduler the following packages are also installed.\n\n* django >= 1.9\n* django-model-utils >= 2.4\n* django-rq >= 0.9 (Django RQ requires RQ >= 0.5.5)\n* rq_scheduler >= 0.6.0\n* pytz >= 2015.7\n\nTesting also requires:\n\n* factory_boy >= 2.6.1\n* psycopg2 >= 2.6.1\n\n\n## Usage\n\n### Install\n\nUse pip to install:\n\n```\npip install django-rq-scheduler\n```\n\n\n### Update Django Settings\n\n1. In `settings.py`, add `django_rq` and `scheduler` to `INSTALLED_APPS`:\n\n\t```\n\n\tINSTALLED_APPS = [\n \t...\n \t'django_rq',\n \t'scheduler',\n \t...\n\t]\n\n\n\t```\n\n2. Configure Django RQ. See https://github.com/ui/django-rq#installation\n\n\n### Migrate\n\nThe last step is migrate the database:\n\n```\n./manage.py migrate\n```\n\n## Creating a Job\n\nSee http://python-rq.org/docs/jobs/ or https://github.com/ui/django-rq#job-decorator\n\nAn example:\n\n**myapp.jobs.py**\n\n```\n@job\ndef count():\n return 1 + 1\n```\n\n## Scheduling a Job\n\n### Scheduled Job\n\n1. Sign into the Django Admin site, http://localhost:8000/admin/ and locate the **Django RQ Scheduler** section.\n\n2. Click on the **Add** link for Scheduled Job.\n\n3. Enter a unique name for the job in the **Name** field.\n\n4. In the **Callable** field, enter a Python dot notation path to the method that defines the job. For the example above, that would be `myapp.jobs.count`\n\n5. Choose your **Queue**. Side Note: The queues listed are defined in the Django Settings.\n\n6. Enter the time the job is to be executed in the **Scheduled time** field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.\n\n7. Click the **Save** button to schedule the job.\n\n### Repeatable Job\n\n1. Sign into the Django Admin site, http://localhost:8000/admin/ and locate the **Django RQ Scheduler** section.\n\n2. Click on the **Add** link for Repeatable Job\n\n3. Enter a unique name for the job in the **Name** field.\n\n4. In the **Callable** field, enter a Python dot notation path to the method that defines the job. For the example above, that would be `myapp.jobs.count`\n\n5. Choose your **Queue**. Side Note: The queues listed are defined in the Django Settings.\n\n6. Enter the time the first job is to be executed in the **Scheduled time** field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.\n\n7. Enter an **Interval**, and choose the **Interval unit**. This will calculate the time before the function is called again.\n\n8. In the **Repeat** field, enter the number of time the job is to be ran. Leaving the field empty, means the job will be scheduled to run forever.\n\n9. Click the **Save** button to schedule the job.\n\n\n## Reporting issues or Features\n\nPlease report issues via [GitHub Issues](https://github.com/istrategylabs/django-rq-scheduler/issues) .\n\n\n\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/istrategylabs/django-rq-scheduler", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "readwise-django-rq-scheduler", "package_url": "https://pypi.org/project/readwise-django-rq-scheduler/", "platform": "", "project_url": "https://pypi.org/project/readwise-django-rq-scheduler/", "project_urls": { "Homepage": "https://github.com/istrategylabs/django-rq-scheduler" }, "release_url": "https://pypi.org/project/readwise-django-rq-scheduler/1.1.3/", "requires_dist": [ "django (>=1.9.0)", "django-model-utils (>=2.4.0)", "django-rq (>=0.9.0)", "pytz (>=2015.7)", "rq-scheduler (>=0.6.0)", "factory-boy (>=2.6.1); extra == 'test'", "psycopg2 (>=2.6.1); extra == 'test'" ], "requires_python": "", "summary": "A database backed job scheduler for Django RQ", "version": "1.1.3" }, "last_serial": 3564921, "releases": { "1.1.1": [ { "comment_text": "", "digests": { "md5": "64f82faf1ccd2323bfee72872b506197", "sha256": "d55285f8975ec9ee7974513df8900f6a542b00cf08dbe66b0b50c1d7b2831d31" }, "downloads": -1, "filename": "readwise_django_rq_scheduler-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "64f82faf1ccd2323bfee72872b506197", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 11731, "upload_time": "2018-02-08T03:30:20", "url": "https://files.pythonhosted.org/packages/b9/89/b303c25f3cde0011e9addaf9cef34986618c8e4cf4a385cce8b18a885849/readwise_django_rq_scheduler-1.1.1-py2.py3-none-any.whl" } ], "1.1.2": [ { "comment_text": "", "digests": { "md5": "6756cca96b4d1c69ae86ad40178d177f", "sha256": "a79b1b15b6f9fef0702458c9541eaa7cd50a88d311f88c527713582a237b58e0" }, "downloads": -1, "filename": "readwise_django_rq_scheduler-1.1.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "6756cca96b4d1c69ae86ad40178d177f", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 12980, "upload_time": "2018-02-08T04:00:37", "url": "https://files.pythonhosted.org/packages/7a/01/f47202f42c75d5d29496ef1bbe9207499621a8fbd7971372b17990a663e2/readwise_django_rq_scheduler-1.1.2-py2.py3-none-any.whl" } ], "1.1.3": [ { "comment_text": "", "digests": { "md5": "a66a197b4cb812070e052b3876a2ee5d", "sha256": "4a26842cc36f5da211c1fea8c48145824d33b4ec68d2077af500551830ebdceb" }, "downloads": -1, "filename": "readwise_django_rq_scheduler-1.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a66a197b4cb812070e052b3876a2ee5d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13620, "upload_time": "2018-02-08T18:40:22", "url": "https://files.pythonhosted.org/packages/1d/62/ca29eba7b6cb6a1b89d8d8810bbfd5bf7d1dc0dca744ed8d33f1b35b96f6/readwise_django_rq_scheduler-1.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5cadd448ad844fa301a3e66eb311b6df", "sha256": "3225e306db8430089b0da3c05ad9263226e9044508a007f0c72ed8de78921762" }, "downloads": -1, "filename": "readwise-django-rq-scheduler-1.1.3.tar.gz", "has_sig": false, "md5_digest": "5cadd448ad844fa301a3e66eb311b6df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9033, "upload_time": "2018-02-08T18:40:23", "url": "https://files.pythonhosted.org/packages/87/c4/1e98dc4c32e63794b55b8c2b6c9de3ec309e2d9923f1c5b88fce96c43929/readwise-django-rq-scheduler-1.1.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a66a197b4cb812070e052b3876a2ee5d", "sha256": "4a26842cc36f5da211c1fea8c48145824d33b4ec68d2077af500551830ebdceb" }, "downloads": -1, "filename": "readwise_django_rq_scheduler-1.1.3-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "a66a197b4cb812070e052b3876a2ee5d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 13620, "upload_time": "2018-02-08T18:40:22", "url": "https://files.pythonhosted.org/packages/1d/62/ca29eba7b6cb6a1b89d8d8810bbfd5bf7d1dc0dca744ed8d33f1b35b96f6/readwise_django_rq_scheduler-1.1.3-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5cadd448ad844fa301a3e66eb311b6df", "sha256": "3225e306db8430089b0da3c05ad9263226e9044508a007f0c72ed8de78921762" }, "downloads": -1, "filename": "readwise-django-rq-scheduler-1.1.3.tar.gz", "has_sig": false, "md5_digest": "5cadd448ad844fa301a3e66eb311b6df", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 9033, "upload_time": "2018-02-08T18:40:23", "url": "https://files.pythonhosted.org/packages/87/c4/1e98dc4c32e63794b55b8c2b6c9de3ec309e2d9923f1c5b88fce96c43929/readwise-django-rq-scheduler-1.1.3.tar.gz" } ] }