cedargrovestudios / circuitpython_leapyear Goto Github PK

A CircuitPython helper that confirms whether a specified year is a leap year.

Leap Year detects a valid leap year from an integer year value. Returns a value of True if the input year value is a valid leap year. Returns False if not a valid leap year.

This driver depends on:

• Adafruit CircuitPython

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.

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install cedargrove_leapyear

Or the following command to update an existing version:

circup update

>>> from cedargrove_leapyear import leap_year
>>> leap_year(2000)  # Leap Year Determination
True
>>> leap_year(2020)
True
>>> leap_year(2021)
False
>>> leap_year(2024)
True
>>> leap_year(2100)
False
>>> leap_year(2104)
True

API documentation for this library can be found here.

For information on building library documentation, please check out this guide.

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