schedule README

The project's README from github.com/dbader/schedule. As one markdown file: README.md.

schedule <https://schedule.readthedocs.io/>__

.. image:: https://github.com/dbader/schedule/workflows/Tests/badge.svg :target: https://github.com/dbader/schedule/actions?query=workflow%3ATests+branch%3Amaster

.. image:: https://coveralls.io/repos/dbader/schedule/badge.svg?branch=master :target: https://coveralls.io/r/dbader/schedule

.. image:: https://img.shields.io/pypi/v/schedule.svg :target: https://pypi.python.org/pypi/schedule

Python job scheduling for humans. Run Python functions (or any other callable) periodically using a friendly syntax.

Usage

.. code-block:: bash

$ pip install schedule

.. code-block:: python

import schedule
import time

def job():
    print("I'm working...")

schedule.every(10).seconds.do(job)
schedule.every(10).minutes.do(job)
schedule.every().hour.do(job)
schedule.every().day.at("10:30").do(job)
schedule.every(5).to(10).minutes.do(job)
schedule.every().monday.do(job)
schedule.every().wednesday.at("13:15").do(job)
schedule.every().day.at("12:42", "Europe/Amsterdam").do(job)
schedule.every().minute.at(":17").do(job)

def job_with_argument(name):
    print(f"I am {name}")

schedule.every(10).seconds.do(job_with_argument, name="Peter")

while True:
    schedule.run_pending()
    time.sleep(1)

Documentation

Schedule's documentation lives at schedule.readthedocs.io <https://schedule.readthedocs.io/>_.

Meta

Daniel Bader - @dbader_org <https://twitter.com/dbader_org>_ - [email protected]

Inspired by Adam Wiggins' <https://github.com/adamwiggins>_ article "Rethinking Cron" <https://adam.herokuapp.com/past/2010/4/13/rethinking_cron/>_ and the clockwork <https://github.com/Rykian/clockwork>_ Ruby module.

Distributed under the MIT license. See LICENSE.txt <https://github.com/dbader/schedule/blob/master/LICENSE.txt>_ for more information.

https://github.com/dbader/schedule

schedule (dbader/schedule)

Searching Database…

12.3K ·GitHub
What is this?Schedule is a lightweight Python library for running jobs periodically using a simple, readable syntax, like running a function every 10 seconds or every Monday.
Is this a library or a standalone scheduler app?It's an in-process library you import into your own Python script; it runs inside your app's loop rather than as a separate daemon or cron service.
How do I add it to my project?Install with pip, import schedule, define jobs with schedule.every(), and call schedule.run_pending() in a loop.
Do I need anything else besides Python installed?No, it has no external dependencies and works as a single lightweight package.
Does it run jobs automatically in the background?No, you must keep your own loop running and call schedule.run_pending() repeatedly (e.g. with time.sleep(1)); there's no background thread by default.
Which platforms does it work on?Pure Python with no native dependencies, so it runs on Linux, macOS, and Windows wherever a supported Python interpreter is available.
What kind of schedules can I define?You can schedule by seconds, minutes, hours, days, specific weekdays like Monday or Wednesday, specific times, timezone-aware times, and even random intervals like every 5 to 10 minutes.
Can I pass arguments to scheduled jobs?Yes, you can pass arguments directly in the .do() call, e.g. schedule.every(10).seconds.do(jobwithargument, name='Peter').
Where can I find full documentation?Full docs are hosted at schedule.readthedocs.io.
Creator
dbader
Size
0.4 MB
Stars
12.3K
Updated
CommitMay 25
Age
13y
Commits · 90 Days