{
    "info": {
        "author": "Unhaggle Inc.",
        "author_email": "",
        "bugtrack_url": null,
        "classifiers": [
            "Environment :: Web Environment",
            "Framework :: Django",
            "Framework :: Django :: 1.11",
            "License :: OSI Approved :: BSD License",
            "Operating System :: POSIX",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3.6",
            "Topic :: Utilities"
        ],
        "description": "# django-cronman\n\n## Overview\n\nDjango app to define and manage periodic tasks at Python level.\n\n## Installation\n\n`django-cronman` can be installed directly from PyPI using `pip`:\n\n```bash\npip install django-cronman\n```\n\nYou can also install it with additional dependencies to be able to use Cron Remote Manager.\n\n```bash\npip install django-cronman[redis]\n```\n\n## Define a new cron job\n\nCron job definition is inspired by Django Admin configuration. To add a new job, you have to create `cron_job.py`\nfile inside an app, create `BaseCronJob` subclass inside and register it:\n\n```python\nfrom cronman.job import BaseCronJob, cron_job_registry\n\nclass HelloWorld(BaseCronJob):\n    \"\"\"Demo Cron Job class\"\"\"\n\n    def run(self):\n        \"\"\"Main logic\"\"\"\n        pass\n\ncron_job_registry.register(HelloWorld)\n```\n\nCron job classes are registered (and referred to) by name, which may be customized on registration:\n```python\ncron_job_registry.register(HelloWorld, name='Hello')\n```\nIt's also possible to retrieve or unregister a class (e.g. while testing):\n```python\ncron_job_registry.get('HelloWorld')\ncron_job_registry.unregister('HelloWorld')\n```\nIf there is more than 1 cron job in given app, it's recommended to create a package instead of single `cron_jobs` module, create one submodule per class and do the imports and registration in package's  `__init__.py`.\n\n## Configure cron jobs\n\nTo ensure that a cron job is executed periodically, you have add an entry to `CRON_JOBS`:\n\n```python\nCRON_JOBS = (\n    ...\n    # (<time spec>, <job spec>)\n    # 'HelloWorld' will be executed a 5:15AM every day:\n    ('   15   5   *   *   *', 'HelloWorld'),\n)\n```\n\nSet ```CRONMAN_JOBS_MODULE``` to the dotted path name of the module where cron jobs are specified. Remember, this module MUST have a ```CRON_JOBS``` attribute. ```CRONMAN_JOBS_MODULE``` is ```None``` by default. For example:\n\n```python\n# settings_local.py\n\nCRONMAN_JOBS_MODULE = 'app.cron_jobs.name'\n```\n\n## Run the scheduler\n\nCron jobs defined in ```settings.CRONMAN_JOBS_MODULE``` are started by `cron_scheduler` command from `cron` app.\nThis command constructs a list of jobs that should be executed in current period (now +/- 1 minute)\nand creates **a new subprocess** for each job.\n```\npython manage.py cron_scheduler run\n```\nThis command should be added to system's crontab on server responsible for running periodic tasks\nand executed every 2 minutes.\n\n## Run single cron job\n\nCommand `cron_worker run <job spec>` is responsible for executing cron jobs:\n```\npython manage.py cron_worker run HelloWorld\n```\n\n## Cron job parameters\n\nCron job classes can accept parameters which are passed to `run` method as positional or named arguments:\n```python\nclass HelloWorld(BaseCronJob):\n    \"\"\"Demo Cron Job class\"\"\"\n\n    def run(self, what, sleep=None):\n        \"\"\"Main logic\"\"\"\n        print \"Hello {}\".format(what)\n        if sleep:\n            time.sleep(int(sleep))\n    ...\n```\n```\npython manage.py cron_worker run HelloWorld:world,sleep=5\n```\nParameters are passed as string values, any type casts should be made in `run` method.\nQuoted string with spaces are supported, but comma can be used only as argument separator:\n```\npython manage.py cron_worker run HelloWorld:\"big world\",sleep=5\n```\nThere are utility functions for extracting lists and boolean values in `cronman.utils` module.\n\n## Configure Cronitor support\n\n`cron_worker` command can notify Cronitor when a job is started, finished or it has failed.\nTo enable this you have to:\n1. Enable Cronitor support in settings `CRONMAN_CRONITOR_ENABLED = True`\n2. Configure you cron job class:\n```python\nclass HelloWorld(BaseCronJob):\n    \"\"\"Demo Cron Job class\"\"\"\n    cronitor_id = 'ab12z'  # ID is assigned in Cronitor's dashboard\n```\n\nWe may disable sending optional \"RUN\" and \"FAIL\" pings to Cronitor when cron job starts by setting `cronitor_ping_run = False` or `cronitor_ping_fail = False` but this doesn't seem to be necessary.\n\n**Important note:**\nWhen adding a new monitor in Cronitor dashboard, please use type **heartbeat**. Avoid using **cron job** monitors, as they're sending false-positive alerts \"Has not run on schedule\".\n\n\n## Configure lock\n\nTasks can acquire locks to prevent concurrent calls. Locks have form of PIDfiles located in `settings.CRONMAN_DATA_DIR`. To modify lock behavior for given cron job class you can set `lock_type` attribute:\n\n```python\nfrom cronman.taxonomies import LockType\n\nclass HelloWorld(BaseCronJob):\n    \"\"\"Demo Cron Job class\"\"\"\n    lock_type = LockType.PARAMS\n```\nThe following values are supported:\n* `None` - no lock, concurrency is allowed\n* `LockType.CLASS` (default) - only one instance of given cron job class can be run at the same time (e.g. `Foo:p=1` and `Foo:p=2` can't work concurrently)\n* `LockType.PARAMS` - only one combination of class and params can be run at the same time (e.g. `Foo:p=1` and `Foo:p=2` can work concurrently, but another call to `Foo:p=1` will be prohibited)\nLocks acquired/released by `cron_worker` command.\n\nWe can configure a shared lock for several cron job classes to make sure only one of them is running:\n\n```python\nfrom cronman.taxonomies import LockType\n\nclass HelloWorld1(BaseCronJob):\n    \"\"\"Demo Cron Job class (1)\"\"\"\n    lock_type = LockType.CLASS\n    lock_name = 'HelloWorld'\n\nclass HelloWorld2(BaseCronJob):\n    \"\"\"Demo Cron Job class (2)\"\"\"\n    lock_type = LockType.CLASS\n    lock_name = 'HelloWorld'\n```\n\n## Configure CPU and IO priority\n\nWe can assign CPU priority (`nice`) to a cron job class by using `worker_cpu_priority` attribute:\n```python\nfrom cronman.taxonomies import CPUPriority\n\nclass NiceHellowWorld(BaseCronJob):\n    \"\"\"Hello World running through `nice -n 19`\"\"\"\n    worker_cpu_priority = CPUPriority.LOWEST\n```\nWe can also customize IO priority (`ionice`) by assigning one of values from `cronman.taxonomies.IOPriority` to `worker_io_priority` attribute, but this is not necessary in most cases, as `nice` changes IO priority as well.\n\nCommands `cron_scheduler run`, `cron_worker resume`, and cron job `RunCronTasks` will spawn worker processes with respect to CPU and IO priorities assigned to cron job classes. These settings **are not** enforced when running `cron_worker run` so you have to prepend `nice`/`ionice` to such calls manually.\n\n## List and kill running cron jobs\n\nCommand `cron_worker status` shows currently running cron jobs - PIDfile name, PID and status (`ALIVE`, `DEAD`).\nSearch results can be limited by `job spec` (cron job name, parameters):\n```\npython manage.py cron_worker status\npython manage.py cron_worker status Foo\npython manage.py cron_worker status Foo:bar=1\n```\n\nCommand `cron_worker kill` kills active cron jobs, gracefully (`SIGTERM`) or by force when process refuses to die (`SIGKILL`). List of tasks can be limited by `job spec`:\n```\npython manage.py cron_worker kill\npython manage.py cron_worker kill Foo\npython manage.py cron_worker kill Foo:bar=1\n```\nSingle process can be killed also using PID:\n```\npython manage.py cron_worker kill 39078\n```\n\n## Resuming cron jobs\n\nSubset of cron jobs can be resumed after being killed:\n\n```python\n\nclass ResumableHelloWorld(BaseCronJob):\n    \"\"\"Demo Cron Job class\"\"\"\n    can_resume = True\n```\n\nCommand `cron_worker resume` starts all killed cron jobs with `can_resume` capability:\n```\npython manage.py cron_worker resume\n```\n\nTo remove all entries about dead cron jobs and make sure they won't be resumed we can run `cron_worker clean` command:\n```\npython manage.py cron_worker clean\n```\n\nCommand `cron_worker suspend` cleans all previous entries about dead cron jobs and then kills all running ones to make sure that next `resume` will raise only recently killed jobs:\n```\npython manage.py cron_worker suspend\n```\n\n\n## List available cron jobs\n\nCommand `cron_worker info` shows list of all available cron jobs:\n```\npython manage.py cron_worker info\n```\nWhen cron job name is passed to this command, system displays docstring and parameters of given cron job:\n```\npython manage.py cron_worker info Foo\n```\n\n## Disable the scheduler\n\nScheduler command can be disabled temporarily:\n```\npython manage.py cron_scheduler disable\n```\nand re-enabled later:\n```\npython manage.py cron_scheduler enable\n```\nCalls to `cron_scheduler run` will not spawn worker processes while scheduler is disabled.\n\n## Send errors to sentry\n\nErrors in cron job classes are intercepted by `cron_worker` and sent to Sentry using the same config as other Django commands (`settings.RAVEN_MANAGEMENT_COMMAND_CONFIG`).\nIf `settings.CRONMAN_RAVEN_CMD` is defined, the scheduler will use it as execution script for worker processes, e.g.\n`python manage.py cron_worker run Foo:bar=1` will be converted to `{CRONMAN_RAVEN_CMD} -c \"python manage.py cron_worker run Foo:bar=1\"`\n\n## Cron Tasks - running cron jobs from Admin area\n\nSome cron jobs can be requested to start from Admin area: **Admin > Cron > Cron Tasks**\nTo add a cron job class to the list in Admin we need to set `ALLOWED_CRON_TASKS` setting:\n\n```python\n\nALLOWED_CRON_TASKS = (\n    'HelloWorld',\n)\n```\nTo request another run of given cron job we can just create a new `CronTask` record in Admin.\nCron job `RunCronTasks` started every 4 minutes by the scheduler will spawn a separate worker process for each pending Cron Task.\n\n## Changelog\n\n2019-04-30 - 1.1.1 Pre-commit.com hooks support. Docs update\n2019-03-13 - 1.1.0 Add support for cronitor ping for cron_scheduler\n2019-02-25 - 1.0.0 Initial version released",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/unhaggle/django-cronman",
        "keywords": "",
        "license": "",
        "maintainer": "",
        "maintainer_email": "",
        "name": "django-cronman",
        "package_url": "https://pypi.org/project/django-cronman/",
        "platform": "",
        "project_url": "https://pypi.org/project/django-cronman/",
        "project_urls": {
            "Homepage": "https://github.com/unhaggle/django-cronman"
        },
        "release_url": "https://pypi.org/project/django-cronman/1.1.1/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Cron management app for Django",
        "version": "1.1.1"
    },
    "last_serial": 5207259,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "6c219282e94b3b9e11ece1723be5e381",
                    "sha256": "904c8b8258ebe80a4708643c931620ef9784cd72deb64eb1feb6be6c14d5710d"
                },
                "downloads": -1,
                "filename": "django-cronman-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "6c219282e94b3b9e11ece1723be5e381",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 50179,
                "upload_time": "2019-02-25T15:05:56",
                "url": "https://files.pythonhosted.org/packages/61/a1/9028d06105cadaf236b6cb56275280b2027172ca64eb5610fc1fc80eddfa/django-cronman-1.0.0.tar.gz"
            }
        ],
        "1.0.0b1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9481cba09353ad7fec65a85646b147ee",
                    "sha256": "15a2bb7115b437ce1f3c9e9ed507bb47fa4a9636e3da399b6d70ac4d28d54ff2"
                },
                "downloads": -1,
                "filename": "django-cronman-1.0.0b1.tar.gz",
                "has_sig": false,
                "md5_digest": "9481cba09353ad7fec65a85646b147ee",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 50145,
                "upload_time": "2018-09-25T16:22:07",
                "url": "https://files.pythonhosted.org/packages/72/76/b8b5ce87712a405214b7a6a3465db3189f2fb8153d4b7089a641ed6c30bc/django-cronman-1.0.0b1.tar.gz"
            }
        ],
        "1.0.0b2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "68345f22b4468e59e5b556fa3089ce51",
                    "sha256": "d1d14e0ba4f93193cdd523ef080c25749a928ff66e2206b4bc2242ab877b4d00"
                },
                "downloads": -1,
                "filename": "django-cronman-1.0.0b2.tar.gz",
                "has_sig": false,
                "md5_digest": "68345f22b4468e59e5b556fa3089ce51",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 53549,
                "upload_time": "2018-11-05T00:20:53",
                "url": "https://files.pythonhosted.org/packages/8e/49/a1f73b9a5dba35b2c00053156e64e1a706ba9f23f338106ed78678b10277/django-cronman-1.0.0b2.tar.gz"
            }
        ],
        "1.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2ff0d03a6acca0dad78b009715b59a57",
                    "sha256": "423de7b791fdc4e123ffe820ec191e03346493c0e5044825b895abf5bf8df64e"
                },
                "downloads": -1,
                "filename": "django-cronman-1.1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "2ff0d03a6acca0dad78b009715b59a57",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 50945,
                "upload_time": "2019-03-13T06:49:13",
                "url": "https://files.pythonhosted.org/packages/0b/0d/edefa86a9ca0fb18c7447492be647d146caf1229e155701b217bd4453e77/django-cronman-1.1.0.tar.gz"
            }
        ],
        "1.1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ce587cbcfa3f08de4653f8a155124766",
                    "sha256": "dab5672bd81ec343250f2fb66ab9a1f71cfeef84b213ae78d22427e9a006a386"
                },
                "downloads": -1,
                "filename": "django-cronman-1.1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "ce587cbcfa3f08de4653f8a155124766",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 51014,
                "upload_time": "2019-04-30T08:56:22",
                "url": "https://files.pythonhosted.org/packages/ca/3b/b1cfd7925afb71eaa22559763ec966fe90d20c78b2cc6d5f2fa841adb1e8/django-cronman-1.1.1.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "ce587cbcfa3f08de4653f8a155124766",
                "sha256": "dab5672bd81ec343250f2fb66ab9a1f71cfeef84b213ae78d22427e9a006a386"
            },
            "downloads": -1,
            "filename": "django-cronman-1.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "ce587cbcfa3f08de4653f8a155124766",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 51014,
            "upload_time": "2019-04-30T08:56:22",
            "url": "https://files.pythonhosted.org/packages/ca/3b/b1cfd7925afb71eaa22559763ec966fe90d20c78b2cc6d5f2fa841adb1e8/django-cronman-1.1.1.tar.gz"
        }
    ]
}