{"id":13586559,"url":"https://github.com/funkyfuture/deck-chores","last_synced_at":"2025-05-14T21:04:39.554Z","repository":{"id":13969815,"uuid":"75514051","full_name":"funkyfuture/deck-chores","owner":"funkyfuture","description":"A job scheduler for Docker containers, configured via labels.","archived":false,"fork":false,"pushed_at":"2025-03-26T04:50:41.000Z","size":995,"stargazers_count":204,"open_issues_count":16,"forks_count":28,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-04-13T16:07:50.495Z","etag":null,"topics":["docker","scheduled-jobs","scheduler","scheduler-service"],"latest_commit_sha":null,"homepage":"https://deck-chores.readthedocs.io/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/funkyfuture.png","metadata":{"files":{"readme":"README.rst","changelog":"HISTORY.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-04T02:59:47.000Z","updated_at":"2025-03-26T04:50:45.000Z","dependencies_parsed_at":"2024-01-15T13:11:06.365Z","dependency_job_id":"583144ff-6b1b-4cf8-998d-fa764eace3a8","html_url":"https://github.com/funkyfuture/deck-chores","commit_stats":{"total_commits":468,"total_committers":12,"mean_commits":39.0,"dds":0.2585470085470085,"last_synced_commit":"860108929557d564135df026f3d7d766c4a2be29"},"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyfuture%2Fdeck-chores","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyfuture%2Fdeck-chores/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyfuture%2Fdeck-chores/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/funkyfuture%2Fdeck-chores/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/funkyfuture","download_url":"https://codeload.github.com/funkyfuture/deck-chores/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248741206,"owners_count":21154255,"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":["docker","scheduled-jobs","scheduler","scheduler-service"],"created_at":"2024-08-01T15:05:39.180Z","updated_at":"2025-04-13T16:07:54.905Z","avatar_url":"https://github.com/funkyfuture.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"deck-chores\n===========\n\n.. image:: https://img.shields.io/docker/pulls/funkyfuture/deck-chores.svg\n        :target: https://hub.docker.com/r/funkyfuture/deck-chores/\n\n.. image:: https://img.shields.io/pypi/v/deck-chores.svg\n        :target: https://pypi.org/project/deck-chores/\n\n**A job scheduler for Docker containers, configured via container labels.**\n\n* Documentation: https://deck-chores.readthedocs.io\n* Image repositories:\n    * https://github.com/funkyfuture/deck-chores/pkgs/container/deck-chores\n    * https://hub.docker.com/r/funkyfuture/deck-chores\n* Code repository: https://github.com/funkyfuture/deck-chores\n* Issue tracker: https://github.com/funkyfuture/deck-chores/issues\n* Free software: ISC license\n\n\nFeatures\n--------\n\n- define regular jobs to run within a container context with container and optionally with image\n  labels\n- use date, interval and cron-like triggers\n- set a maximum of simultaneously running instances per job\n- restrict job scheduling to one container per service\n- multi-architecture image supports ``amd64``, ``arm64`` and ``arm`` platforms\n  (the latter are currently not provided for download)\n\n\nExample\n-------\n\nLet's say you want to dump the database of a Wordpress once a day. Here's a ``docker-compose.yml``\nthat defines a job that will be handled by *deck-chores*:\n\n.. code-block:: yaml\n\n    version: \"3.7\"\n\n    services:\n      wordpress:\n        image: wordpress\n      mysql:\n        image: mariadb\n        volumes:\n          - ./database_dumps:/dumps\n        labels:\n          deck-chores.dump.command: sh -c \"mysqldump --all-databases \u003e /dumps/dump-$$(date -Idate)\"\n          deck-chores.dump.interval: daily\n\nIt is however recommended to use scripts with a proper shebang for such actions. Their outputs to\n``stdout`` and ``stderr`` as well as their exit code will be logged by *deck-chores*.\n\n\nMaintenance\n-----------\n\nThe final release is supposed to receive monthly updates that includes updates\nof all updateable dependencies. If one is skipped, don't worry. When a second\nmaintenance release is skipped, feel free to open an issue to ask what the\nstatus is.\n\nYou can always build images upon an up-to-date base image with::\n\n    make build\n\n\nLimitations\n-----------\n\nWhen running on a cluster of `Docker Swarm \u003chttps://docs.docker.com/engine/swarm/\u003e`_\nnodes, each ``deck-chores`` instance can only observe the containers on the\nnode it's running on, and hence only restrict to run one job per service within\nthe node's context.\n\n\nAcknowledgements\n----------------\n\nIt wouldn't be as charming to write this piece of software without these projects:\n\n* `APScheduler \u003chttps://apscheduler.readthedocs.io\u003e`_ for managing jobs\n* `cerberus \u003chttp://python-cerberus.org\u003e`_ for processing metadata\n* `docker-py \u003chttps://docker-py.readthedocs.io\u003e`_ for Docker interaction\n* `flake8 \u003chttp://flake8.pycqa.org/\u003e`_, `mypy \u003chttp://mypy-lang.org\u003e`_,\n  `pytest \u003chttp://pytest.org\u003e`_ and `tox \u003chttps://tox.readthedocs.io\u003e`_ for testing\n* `Python \u003chttps://www.python.org\u003e`_\n\n\nAuthors\n-------\n\n- Frank Sachsenheim (maintaining)\n- aeri4list\n- alpine-digger\n- Brynjar Smári Bjarnason\n- Garret Hohmann\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkyfuture%2Fdeck-chores","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffunkyfuture%2Fdeck-chores","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffunkyfuture%2Fdeck-chores/lists"}