CircuitPython Libraries

The CircuitPython Library Bundle contains all current libraries available for CircuitPython. They are designed for use with CircuitPython and may or may not work with MicroPython. The bundle options are explained below.

CircuitPython libraries are separate files designed to work with CircuitPython code. CircuitPython programs require a lot of information to run. CircuitPython is so simple to use because most of this information is processed in the background and stored in libraries. Some libraries are built into CircuitPython. Others are downloaded and stored on your CIRCUITPY drive in a folder called lib.

The full list of all the CircuitPython libraries contained in the following bundles can be found on the libraries page.

Download and Installation Instructions

The libraries in each release are compiled to .mpy for all recent major versions of CircuitPython. Please download the bundle that matches the major version of your CircuitPython. For example, if you are running 5.0.0 you should download the 5.x bundle. The .mpy files are designed to take up less space on your CIRCUITPY drive. Unless you have a specific reason, choose the appropiate .mpy library bundle!

To install, download the appropriate bundle for your version of CircuitPython. Unzip the file, open the resulting folder and find the lib folder. Open the lib folder and find the library files you need to load. Create a lib folder on your CIRCUITPY drive. Copy the individual library files you need to the lib folder on your CIRCUITPY drive.

You can always find the latest releases of the libraries bundle on GitHub.

Bundle Version 5.x

This bundle is built for use with CircuitPython 5.x.x. If you are using CircuitPython 5, please download this bundle.

Bundle Version 4.x

This bundle is built for use with CircuitPython 4.x.x. If you are using CircuitPython 4, please download this bundle.

Bundle Version py

This bundle is the uncompiled source code for every library. It is not intended for general use! It is only recommended if you need to edit a library file. This bundle works with all versions of CircuitPython.

Bundle Examples

Every CircuitPython library has examples to go along with it. This bundle contains every library example. This bundle will have examples that require the latest version of CircuitPython, and therefore contains files that may not work with all versions.

Contributing

If you'd like to contribute to the CircuitPython project, the CircuitPython libraries are a great way to begin. Everyone is welcome to contribute! Regardless of your experience level, we have many resources to get you started. Check out the Contributing page for detailed information!

Find out more about how you can contribute to CircuitPython libraries.

Library Activity for Week of Wed, Nov 20, 2019

Thank you to all of our contributors!

This week there were 11 pull requests merged:

New Libraries