adafruit-mirror/Adafruit_CircuitPython_Bundle

No description

Find a file

Scott Shawcroft a9de1740f9 Switch bundle build for build tools 0.0.8 which has proper argument parsing.		2017-11-30 12:08:56 -08:00
circuitpython@a1409d1432	Update to coincide with CircuitPython 2.1 release. (#31 )	2017-10-19 21:02:46 -04:00
libraries	Automated update by Adabot (adafruit/adabot@deab33c )	2017-11-21 15:35:39 -08:00
update_scripts	Switch to CircuitPython and add badges to the README.	2017-01-06 11:27:28 -08:00
.gitignore	Switch bundle build for build tools 0.0.8 which has proper argument parsing.	2017-11-30 12:08:56 -08:00
.gitmodules	Add GPS, VC0706.	2017-11-10 18:54:01 -08:00
.travis.yml	Switch bundle build for build tools 0.0.8 which has proper argument parsing.	2017-11-30 12:08:56 -08:00
build-bundles.py	Update build-bundles to use circuitpython 2.1.0.	2017-10-19 21:10:23 -04:00
CODE_OF_CONDUCT.md	Build the bundle on Travis.	2017-11-22 15:53:06 -08:00
LICENSE	Initial commit	2016-10-28 10:56:38 -07:00
README.md	[#19 ] Update script name under the "Building the bundle" section.	2017-10-08 10:58:15 -06:00
README.txt	Switch to CircuitPython and add badges to the README.	2017-01-06 11:27:28 -08:00
requirements.txt	Build the bundle on Travis.	2017-11-22 15:53:06 -08:00
update-submodules.sh	Build multiple bundles automatically.	2017-09-18 12:17:58 -07:00

README.md

Adafruit CircuitPython Library Bundle

This repo bundles a bunch of useful CircuitPython libraries into an easy to download zip file. CircuitPython boards can ship with the contents of the zip to make it easy to provide a lot of libraries by default.

Use

To use the bundle download the zip (not source zip) from the latest release, unzip it and copy over the subfolders, such as lib, into the root of your CircuitPython device. Make sure to indicate that it should be merged with the existing folder when it exists.

Development

After you clone this repository you must run git submodule init and then git submodule update.

Updating libraries

To update the libraries run update-submodules.sh. The script will fetch the latest code and update to the newest tag (not master).

To find libraries with commits that haven't been included in a release do:

git submodule foreach "git log --oneline HEAD...origin/master"

Adding a library

Determine the best location within libraries for the new library and then run:

git submodule add <git url> libraries/<target directory>

The target directory should omit any MicroPython or CircuitPython specific prefixes such as adafruit-micropython to simplify the listing.

Removing a library

Only do this if you are replacing the module with an equivalent:

git submodule deinit libraries/<target directory>
git rm libraries/<target directory>

Building the bundle

To build the bundle run build-bundles.py it requires Python 3.5+ and will produce a zip file in build. The file structure of the zip will not be identical to the source libraries directory in order to save space. Libraries with a single source will not be placed in their own directory.

Note that adafruit/circuitpython is one of the submodules that is included. It is used to build mpy-cross to compile the .py files to .mpy. It is updated to the latest available tag when you run update-submodules.sh.

If you don't want to use the latest tagged version, make sure you checkout an appropriate branch or tag of circuitpython to match the bundle version you want to build.