Skip to content

Commit

Permalink
Switch to CircuitPython and add badges to the README.
Browse files Browse the repository at this point in the history
  • Loading branch information
tannewt committed Jan 6, 2017
1 parent 0dec953 commit e9a93f2
Show file tree
Hide file tree
Showing 8 changed files with 22 additions and 18 deletions.
10 changes: 5 additions & 5 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[submodule "micropython"]
path = micropython
url = https://github.com/adafruit/micropython
[submodule "circuitpython"]
path = circuitpython
url = https://github.com/adafruit/circuitpython
[submodule "libraries/drivers/pca9685"]
path = libraries/drivers/pca9685
url = git@github.com:adafruit/micropython-adafruit-pca9685.git
Expand Down Expand Up @@ -30,10 +30,10 @@
url = git@github.com:adafruit/micropython-adafruit-tcs34725.git
[submodule "libraries/register"]
path = libraries/helpers/register
url = git@github.com:adafruit/Adafruit_MicroPython_Register.git
url = git@github.com:adafruit/Adafruit_CircuitPython_Register.git
[submodule "libraries/bus_device"]
path = libraries/helpers/bus_device
url = git@github.com:adafruit/Adafruit_MicroPython_BusDevice.git
url = git@github.com:adafruit/Adafruit_CircuitPython_BusDevice.git
[submodule "libraries/drivers/neopixel"]
path = libraries/drivers/neopixel
url = git@github.com:adafruit/Adafruit_MicroPython_NeoPixel.git
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Adafruit's MicroPython Bundle
This repo bundles a bunch of useful MicroPython libraries into an easy to
download zip file. MicroPython boards can ship with the contents of the zip to
# Adafruit CircuitPython Library Bundle

[![Doc Status](https://readthedocs.org/projects/circuitpython/badge/?version=latest)](https://circuitpython.readthedocs.io/en/latest/docs/drivers.html) [![Gitter](https://badges.gitter.im/adafruit/circuitpython.svg)](https://gitter.im/adafruit/circuitpython?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

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 into the root of your MicroPython device.
unzip it and copy over the subfolders, such as `lib`, into the root of your
CircuitPython device.

# Development

Expand All @@ -21,8 +25,8 @@ 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 specific prefixes such as
`micropython-adafruit` to simplify the listing.
The target directory should omit any MicroPython or CircuitPython specific
prefixes such as `adafruit-micropython` to simplify the listing.

## Building the bundle
To build the bundle run `build-bundle.py` it requires Python 3.5+ and will
Expand Down
2 changes: 1 addition & 1 deletion README.txt
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
See here for more info: https://github.com/adafruit/micropython-adafruit-bundle
See here for more info: https://github.com/adafruit/Adafruit_CircuitPython_Bundle
See VERSIONS.txt for version info.
6 changes: 3 additions & 3 deletions build-bundle.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,15 @@
import subprocess
import zipfile

os.chdir("micropython/mpy-cross")
os.chdir("circuitpython/mpy-cross")
make = subprocess.run(["make"])
os.chdir("../../")

if make.returncode != 0:
print("Unable to make mpy-cross.")
sys.exit(1)

mpy_cross = "micropython/mpy-cross/mpy-cross"
mpy_cross = "circuitpython/mpy-cross/mpy-cross"

if "build" in os.listdir("."):
print("Deleting existing build.")
Expand Down Expand Up @@ -125,7 +125,7 @@
else:
f.write(repo.decode("utf-8", "strict") + "/releases/tag/" + line.strip().decode("utf-8", "strict") + "\r\n")

zip_filename = 'build/adafruit-micropython-bundle-' + version.decode("utf-8", "strict") + '.zip'
zip_filename = 'build/adafruit-circuitpython-bundle-' + version.decode("utf-8", "strict") + '.zip'

def add_file(bundle, src_file, zip_name):
global total_size
Expand Down
2 changes: 1 addition & 1 deletion update_scripts/update_linux.sh
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#! /bin/bash
latest_release=$(curl -s "https://api.github.com/repos/adafruit/micropython-adafruit-bundle/releases/latest")
latest_release=$(curl -s "https://api.github.com/repos/adafruit/Adafruit_CircuitPython_Bundle/releases/latest")
download_link=$(echo $latest_release | grep -o "\"browser_download_url\": \"[^\"]*" | cut -d \" -f 4)
tag=$(echo $latest_release | grep -o "\"tag_name\": \"[^\"]*" | cut -d \" -f 4)
current=$(head -n 1 VERSIONS.txt | tr -d '[:space:]')
Expand Down
2 changes: 1 addition & 1 deletion update_scripts/update_macosx.command
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#! /bin/bash
cd $(dirname $0)
latest_release=$(curl -s "https://api.github.com/repos/adafruit/micropython-adafruit-bundle/releases/latest")
latest_release=$(curl -s "https://api.github.com/repos/adafruit/Adafruit_CircuitPython_Bundle/releases/latest")
download_link=$(echo $latest_release | grep -o "\"browser_download_url\": \"[^\"]*" | cut -d \" -f 4)
tag=$(echo $latest_release | grep -o "\"tag_name\": \"[^\"]*" | cut -d \" -f 4)
current=$(head -n 1 VERSIONS.txt | tr -d '[:space:]')
Expand Down

0 comments on commit e9a93f2

Please sign in to comment.