{"id":13507122,"url":"https://github.com/quantum-elixir/quantum-core","last_synced_at":"2025-05-14T23:00:23.059Z","repository":{"id":31104521,"uuid":"34663848","full_name":"quantum-elixir/quantum-core","owner":"quantum-elixir","description":":watch: Cron-like job scheduler for Elixir","archived":false,"fork":false,"pushed_at":"2025-04-17T08:18:13.000Z","size":960,"stargazers_count":2356,"open_issues_count":9,"forks_count":148,"subscribers_count":30,"default_branch":"main","last_synced_at":"2025-05-07T22:01:58.932Z","etag":null,"topics":["cron","crontab","crontab-format","elixir","quantum","scheduler","timezone"],"latest_commit_sha":null,"homepage":"https://hexdocs.pm/quantum/","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/quantum-elixir.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","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,"zenodo":null},"funding":{"github":"maennchen"}},"created_at":"2015-04-27T11:56:49.000Z","updated_at":"2025-05-06T11:47:56.000Z","dependencies_parsed_at":"2024-04-15T00:06:17.182Z","dependency_job_id":"ab9a13a3-1bd1-4103-865d-9e6a94814606","html_url":"https://github.com/quantum-elixir/quantum-core","commit_stats":{"total_commits":587,"total_committers":82,"mean_commits":7.158536585365853,"dds":0.65587734241908,"last_synced_commit":"3e3ccb911c54b9784c5ff44c2fabf3664577a6e1"},"previous_names":[],"tags_count":66,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantum-elixir%2Fquantum-core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantum-elixir%2Fquantum-core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantum-elixir%2Fquantum-core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/quantum-elixir%2Fquantum-core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/quantum-elixir","download_url":"https://codeload.github.com/quantum-elixir/quantum-core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253587995,"owners_count":21932161,"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":["cron","crontab","crontab-format","elixir","quantum","scheduler","timezone"],"created_at":"2024-08-01T02:00:24.457Z","updated_at":"2025-05-14T23:00:23.032Z","avatar_url":"https://github.com/quantum-elixir.png","language":"Elixir","funding_links":["https://github.com/sponsors/maennchen"],"categories":["Top 20 packages","Date and Time","Elixir"],"sub_categories":[],"readme":"# Quantum\n\n[![.github/workflows/branch_main.yml](https://github.com/quantum-elixir/quantum-core/actions/workflows/branch_main.yml/badge.svg)](https://github.com/quantum-elixir/quantum-core/actions/workflows/branch_main.yml)\n[![Coverage Status](https://coveralls.io/repos/quantum-elixir/quantum-core/badge.svg?branch=main)](https://coveralls.io/r/quantum-elixir/quantum-core?branch=main)\n[![Module Version](https://img.shields.io/hexpm/v/quantum.svg)](https://hex.pm/packages/quantum)\n[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/quantum/)\n[![Total Download](https://img.shields.io/hexpm/dt/quantum.svg)](https://hex.pm/packages/quantum)\n[![License](https://img.shields.io/hexpm/l/quantum.svg)](https://github.com/quantum-elixir/quantum-core/blob/main/LICENSE)\n[![Last Updated](https://img.shields.io/github/last-commit/quantum-elixir/quantum-core.svg)](https://github.com/quantum-elixir/quantum-core/commits/main)\n\n\u003e **This README follows main, which may not be the currently published version**. Here are the\n[docs for the latest published version of Quantum](https://hexdocs.pm/quantum/readme.html).\n\n[Cron](https://en.wikipedia.org/wiki/Cron)-like job scheduler for [Elixir](http://elixir-lang.org/).\n\n## Setup\n\nTo use Quantum in your project, edit the `mix.exs` file and add `Quantum` to\n\n**1. the list of dependencies:**\n```elixir\ndefp deps do\n  [\n    {:quantum, \"~\u003e 3.0\"}\n  ]\nend\n```\n\n**2. and create a scheduler for your app:**\n```elixir\ndefmodule Acme.Scheduler do\n  use Quantum, otp_app: :your_app\nend\n```\n\n**3. and your application's supervision tree:**\n```elixir\ndefmodule Acme.Application do\n  use Application\n\n  def start(_type, _args) do\n    children = [\n      # This is the new line\n      Acme.Scheduler\n    ]\n\n    opts = [strategy: :one_for_one, name: Acme.Supervisor]\n    Supervisor.start_link(children, opts)\n  end\nend\n```\n\n## Troubleshooting\n\nTo see more transparently what `quantum` is doing, configure the `logger` to display `:debug` messages.\n\n```elixir\nconfig :logger, level: :debug\n```\n\nIf you want do use the logger in debug-level without the messages from quantum:\n\n```elixir\nconfig :acme, Acme.Scheduler,\n  debug_logging: false\n```\n\nIf you encounter any problems with `quantum`, please search if there is already an\n  [open issue](https://github.com/quantum-elixir/quantum-core/issues) addressing the problem.\n\nOtherwise feel free to [open an issue](https://github.com/quantum-elixir/quantum-core/issues/new). Please include debug logs.\n\n## Usage\n\nConfigure your cronjobs in your `config/config.exs` like this:\n\n```elixir\nconfig :acme, Acme.Scheduler,\n  jobs: [\n    # Every minute\n    {\"* * * * *\",      {Heartbeat, :send, []}},\n    # Every 15 minutes\n    {\"*/15 * * * *\",   fn -\u003e System.cmd(\"rm\", [\"/tmp/tmp_\"]) end},\n    # Runs on 18, 20, 22, 0, 2, 4, 6:\n    {\"0 18-6/2 * * *\", fn -\u003e :mnesia.backup('/var/backup/mnesia') end},\n    # Runs every midnight:\n    {\"@daily\",         {Backup, :backup, []}}\n  ]\n```\n\nMore details on the usage can be found in the [Documentation](https://hexdocs.pm/quantum/configuration.html)\n\n## Contribution\n\nThis project uses the [Collective Code Construction Contract (C4)](http://rfc.zeromq.org/spec:42/C4/) for all code changes.\n\n\u003e \"Everyone, without distinction or discrimination, SHALL have an equal right to become a Contributor under the terms of this contract.\"\n\n### TL;DR\n\n1. Check for [open issues](https://github.com/quantum-elixir/quantum-core/issues) or [open a new issue](https://github.com/quantum-elixir/quantum-core/issues/new) to start a discussion around [a problem](https://www.youtube.com/watch?v=_QF9sFJGJuc).\n2. Issues SHALL be named as \"Problem: _description of the problem_\".\n3. Fork the [quantum-elixir repository on GitHub](https://github.com/quantum-elixir/quantum-core) to start making your changes\n4. If possible, write a test which shows that the problem was solved.\n5. Send a pull request.\n6. Pull requests SHALL be named as \"Solution: _description of your solution_\"\n7. Your pull request is merged and you are added to the [list of contributors](https://github.com/quantum-elixir/quantum-core/graphs/contributors)\n\n## Copyright and License\n\nCopyright (c) 2015 Constantin Rack\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantum-elixir%2Fquantum-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquantum-elixir%2Fquantum-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquantum-elixir%2Fquantum-core/lists"}