https://github.com/cedargrovestudios/circuitpython_leapyear

A CircuitPython helper that confirms whether a specified year is a leap year.
https://github.com/cedargrovestudios/circuitpython_leapyear

circuitpython circuitpython-community-bundle helper leap-year

Last synced: about 1 month ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/cedargrovestudios/circuitpython_leapyear
• Owner: CedarGroveStudios
• License: mit
• Created: 2022-10-22T19:41:07.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2023-02-07T02:04:25.000Z (almost 2 years ago)
• Last Synced: 2024-07-30T17:35:50.916Z (5 months ago)
• Topics: circuitpython, circuitpython-community-bundle, helper, leap-year
• Language: Python
• Homepage:
• Size: 88.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
Introduction

============

.. image:: https://img.shields.io/discord/327254708534116352.svg

    :target: https://adafru.it/discord

    :alt: Discord

.. image:: https://github.com/CedarGroveStudios/CircuitPython_LeapYear/workflows/Build%20CI/badge.svg

    :target: https://github.com/CedarGroveStudios/CircuitPython_LeapYear/actions

    :alt: Build Status

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :target: https://github.com/psf/black

    :alt: Code Style: Black

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.

Dependencies

=============

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 `_.

Installing to a Connected CircuitPython Device with Circup

==========================================================

Make sure that you have ``circup`` installed in your Python environment.

Install it with the following command if necessary:

.. code-block:: shell

    pip3 install circup

With ``circup`` installed and your CircuitPython device connected use the

following command to install:

.. code-block:: shell

    circup install cedargrove_leapyear

Or the following command to update an existing version:

.. code-block:: shell

    circup update

Usage Example

=============

.. code-block:: python

    >>> 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

Documentation

=============

API documentation for this library can be found `here `_.

For information on building library documentation, please check out

`this guide `_.

Contributing

============

Contributions are welcome! Please read our `Code of Conduct

`_

before contributing to help this project stay welcoming.