Introduction

Reduced version of the schedule library for CircuitPython

This library is a reduced version of the Python schedule library. Credit to Dan Bader (dbader) for this excellent library.

Dependencies

This driver depends on:

• Adafruit CircuitPython
• Adafruit CircuitPython Datetime

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.Installing from PyPI =====================

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install circuitpython-schedule

To install system-wide (this may be required in some cases):

sudo pip3 install circuitpython-schedule

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .env
source .env/bin/activate
pip3 install circuitpython-schedule

Usage Example

import time
import circuitpython_schedule as schedule

def greet():
    print("Hello, world!")

""" Note: pass the function name, like greet, not greet():"""
schedule.every(10).seconds.do(greet)

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

Contributing

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Documentation

Read the module documentation.