index.html
1 --- 2 layout: default 3 title: Libraries 4 permalink: /libraries 5 --- 6 7 <div id="libraries-page" class="common-layout"> 8 <div class="content"> 9 <h1>CircuitPython Libraries</h1> 10 <p> 11 The CircuitPython Library Bundle contains all current libraries available for 12 CircuitPython. They are designed for use with CircuitPython and may or may not 13 work with MicroPython. The bundle options are explained below. 14 <p> 15 CircuitPython libraries are separate files designed to work with CircuitPython code. 16 CircuitPython programs require a lot of information to run. CircuitPython is so simple 17 to use because most of this information is processed in the background and stored in 18 libraries. Some libraries are built into CircuitPython. Others are downloaded and 19 stored on your CIRCUITPY drive in a folder called lib. 20 </p> 21 <p> 22 The full list of all the CircuitPython libraries contained in the following bundles 23 can be found on the 24 <a href="https://circuitpython.readthedocs.io/projects/bundle/en/latest/drivers.html" title="">libraries page</a>. 25 <section> 26 <h2>Download and Installation Instructions</h2> 27 <p> 28 The libraries in each release are compiled to .mpy for all recent major versions 29 of CircuitPython. Please download the bundle that matches the major version 30 of your CircuitPython. For example, if you are running 5.0.0 you should 31 download the 5.x bundle. The .mpy files are designed to take up less space on 32 your CIRCUITPY drive. Unless you have a specific reason, choose the appropiate 33 .mpy library bundle! 34 </p> 35 <p> 36 <b>To install</b>, download the appropriate bundle for your version of CircuitPython. 37 Unzip the file, open the resulting folder and find the lib folder. Open the lib 38 folder and find the library files you need to load. Create a lib folder on your 39 CIRCUITPY drive. Copy the individual library files you need to the lib folder 40 on your CIRCUITPY drive. 41 </p> 42 <p> 43 You can always find the 44 <a href="https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/latest">latest releases of the libraries bundle</a> 45 on GitHub. 46 <div class="release-section"> 47 <div id="adafruit-circuitpython-bundle-5.x-mpy"> 48 <h3>Bundle Version 5.x</h3> 49 <p> 50 This bundle is built for use with CircuitPython 5.x.x. If you are using 51 CircuitPython 5, please download this bundle. 52 </p> 53 </div> 54 <div id="adafruit-circuitpython-bundle-4.x-mpy"> 55 <h3>Bundle Version 4.x</h3> 56 <p> 57 This bundle is built for use with CircuitPython 4.x.x. If you are using 58 CircuitPython 4, please download this bundle. 59 </p> 60 </div> 61 <div id="adafruit-circuitpython-bundle-py"> 62 <h3>Bundle Version py</h3> 63 <p> 64 This bundle is the uncompiled source code for every library. It is not 65 intended for general use! It is only recommended if you need to edit 66 a library file. This bundle works with all versions of CircuitPython. 67 </p> 68 </div> 69 <div id="adafruit-circuitpython-bundle-examples"> 70 <h3>Bundle Examples</h3> 71 <p> 72 Every CircuitPython library has examples to go along with it. This bundle 73 contains every library example. This bundle will have examples that 74 require the latest version of CircuitPython, and therefore contains files 75 that may not work with all versions. 76 </p> 77 </div> 78 </div> 79 </section> 80 <section> 81 <h2>Contributing</h2> 82 <p> 83 If you'd like to contribute to the CircuitPython project, the CircuitPython 84 libraries are a great way to begin. Everyone is welcome to contribute! 85 Regardless of your experience level, we have many resources to get you 86 started. Check out the Contributing page for detailed information! 87 </p> 88 <p> 89 Find out more about how you can 90 <a href="{{ "/libraries/contributing" | relative_url }}" title="Contributing Page">contribute to CircuitPython libraries</a>. 91 </p> 92 <h2>Library Activity for Week of {{ site.data.libraries.updated_at | date: "%a, %b %d, %Y" }}</h2> 93 <p> 94 Thank you to all of our contributors! 95 </p> 96 <p> 97 This week there were {{ site.data.libraries.merged_pr_count }} pull requests merged: 98 <ul> 99 <li> 100 Authors: 101 {% for contributor in site.data.libraries.contributors %} 102 <a href="https://github.com/{{contributor}}" title="Contributor Name">{{contributor}}</a>{% if forloop.last != true %}, {% endif %} 103 {% endfor %} 104 </li> 105 <li> 106 Reviewers: 107 {% for reviewer in site.data.libraries.reviewers %} 108 <a href="https://github.com/{{reviewer}}" title="Contributor Name">{{reviewer}}</a>{% if forloop.last != true %}, {% endif %} 109 {% endfor %} 110 </li> 111 </ul> 112 </p> 113 <div class="libraries new"> 114 <h3>New Libraries</h3> 115 <ul> 116 {% for library in site.data.libraries.library_updates.new %} 117 <li><a href="{{library[1]}}" title="New Library Location">{{library[0]}}</a></li> 118 {% endfor %} 119 </ul> 120 </div> 121 <div class="libraries updated"> 122 <h3>Updated Libraries</h3> 123 <ul> 124 {% for library in site.data.libraries.library_updates.updated %} 125 <li><a href="{{library[1]}}" title="Updated Library Location">{{library[0]}}</a></li> 126 {% endfor %} 127 </ul> 128 </div> 129 </section> 130 </div> 131 </div> 132 133 <script src="/assets/javascript/libraries.js"></script>