{"id":18403716,"url":"https://github.com/russellluo/goodjob","last_synced_at":"2026-07-21T00:48:46.172Z","repository":{"id":30470650,"uuid":"34024667","full_name":"RussellLuo/goodjob","owner":"RussellLuo","description":"A service for executing asynchronous jobs.","archived":false,"fork":false,"pushed_at":"2022-01-06T22:23:03.000Z","size":42,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-17T08:07:28.420Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RussellLuo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-15T23:57:21.000Z","updated_at":"2018-10-08T03:36:57.000Z","dependencies_parsed_at":"2022-09-07T21:11:35.026Z","dependency_job_id":null,"html_url":"https://github.com/RussellLuo/goodjob","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RussellLuo%2Fgoodjob","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RussellLuo%2Fgoodjob/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RussellLuo%2Fgoodjob/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RussellLuo%2Fgoodjob/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RussellLuo","download_url":"https://codeload.github.com/RussellLuo/goodjob/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618279,"owners_count":21134201,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-06T02:48:00.244Z","updated_at":"2025-10-16T00:35:39.196Z","avatar_url":"https://github.com/RussellLuo.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Goodjob\n=======\n\nA service for executing asynchronous jobs.\n\n\nInstallation\n------------\n\nInstall `Goodjob` with `pip`:\n\n    $ pip install Goodjob\n\nInstall development version from `GitHub`:\n\n    $ git clone https://github.com/RussellLuo/goodjob.git\n    $ cd goodjob\n    $ python setup.py install\n\n\nQuickstart\n----------\n\n### 1. Start databases\n\nStart the MongoDB server (used by the Goodjob API):\n\n    $ mongod\n\nStart the Redis server (used by Celery):\n\n    $ redis-server\n\n### 2. Start services\n\nStart the Goodjob API:\n\n    $ restart goodjob.api:api\n\nStart the Celery worker (only handles the `goodjob` queue):\n\n    $ celery worker --app=goodjob.celery.app -Q goodjob --loglevel=info\n\nStart the Celery scheduler (for periodic jobs):\n\n    $ celery beat --app=goodjob.celery.app --loglevel=info\n\nIt is tedious to manage all the services by hand, you can ask the awesome `Supervisor` for help:\n\n    $ supervisord -c ${GOODJOB_PROJ}/supervisord.conf\n    $ supervisorctl -c ${GOODJOB_PROJ}/supervisord.conf status\n\n### 3. Create jobs\n\nCreate an one-off job:\n\n    $ curl -i -X POST -H \"Content-Type: application/json\" -d '{\n        \"name\": \"greet\",\n        \"provider\": {\"type\": \"shell\", \"command\": \"echo\", \"args\": [\"hello\"]}\n    }' http://127.0.0.1:5000/jobs\n\nor a periodic job (in crontab-style):\n\n    $ curl -i -X POST -H \"Content-Type: application/json\" -d '{\n        \"name\": \"greet\",\n        \"provider\": {\"type\": \"shell\", \"command\": \"echo\", \"args\": [\"hello\"]},\n        \"schedule\": \"* * * * *\"\n    }' http://127.0.0.1:5000/jobs\n\nBesides Shell jobs, Goodjob also supports Python jobs. A Python job is a Python callable specified by its Python path. For example:\n\n    $ curl -i -X POST -H \"Content-Type: application/json\" -d '{\n        \"name\": \"email\",\n        \"provider\": {\n            \"type\": \"python\",\n            \"command\": \"python_path.to.utility.send_email\",\n            \"kwargs\": {\"to\": \"user@example.com\", \"subject\": \"Welcome\", \"body\": \"Hi there, buddy!\"}\n        }\n    }' http://127.0.0.1:5000/jobs\n\nInspect the job:\n\n    $ curl -i http://127.0.0.1:5000/jobs/\u003cjob-id\u003e\n\nSee the job log:\n\n    $ curl -i http://127.0.0.1:5000/jobs/\u003cjob-id\u003e/log\n\n### 4. Cancel jobs\n\nCancel a job (use [JSON Patch][1] syntax):\n\n    $ curl -i -X PATCH -H \"Content-Type: application/json\" -d '[{\n        \"op\": \"add\",\n        \"path\": \"/status\",\n        \"value\": \"cancelled\"\n    }]' http://127.0.0.1:5000/jobs/\u003cjob-id\u003e\n\n### 5. Delete jobs\n\nDelete a job:\n\n    $ curl -i -X DELETE http://127.0.0.1:5000/jobs/\u003cjob-id\u003e\n\n\nLicense\n-------\n\n[MIT][2]\n\n\n[1]: http://tools.ietf.org/html/rfc6902\n[2]: http://opensource.org/licenses/MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frussellluo%2Fgoodjob","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frussellluo%2Fgoodjob","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frussellluo%2Fgoodjob/lists"}