Skip to content

Commit 91bbf44

Browse files
Replace content of original CircuitPython community bundle with content for Qwiic_SerLCD__Py
1 parent 5ce12ef commit 91bbf44

File tree

168 files changed

+50
-875
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

168 files changed

+50
-875
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,4 @@ jobs:
4747
with:
4848
asset_path: "bundles/*"
4949
github_token: ${{ secrets.GITHUB_TOKEN }}
50-
upload_url: ${{ github.event.release.upload_url }}
51-
- name: Upload Assets To AWS S3
52-
env:
53-
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
54-
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
55-
run: "[ -z \"$AWS_ACCESS_KEY_ID\" ] || aws s3 cp bundles/ s3://adafruit-circuit-python/bundles/community --recursive --no-progress --region us-east-1"
50+
upload_url: ${{ github.event.release.upload_url }}

.gitmodules

Lines changed: 3 additions & 480 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 44 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,48 @@
1-
# CircuitPython Community Library Bundle
1+
Qwiic_SerLCD_CircupBundle NOTE: CURRENTLY STILL IN DEVELOPMENT!
2+
==============
3+
4+
<p align="center">
5+
<img src="https://cdn.sparkfun.com/assets/custom_pages/2/7/2/qwiic-logo-registered.jpg" width=200>
6+
<img src="https://www.python.org/static/community_logos/python-logo-master-v3-TM.png" width=240>
7+
</p>
8+
<p align="center">
9+
<a href="https://pypi.org/project/sparkfun-qwiic-serlcd/" alt="Package">
10+
<img src="https://img.shields.io/pypi/pyversions/sparkfun_qwiic_serlcd.svg" /></a>
11+
<a href="https://github.com/sparkfun/Qwiic_SerLCD_Py/issues" alt="Issues">
12+
<img src="https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py.svg" /></a>
13+
<a href="https://qwiic-serlcd-py.readthedocs.io/en/latest/" alt="Documentation">
14+
<img src="https://readthedocs.org/projects/qwiic-serlcd-py/badge/?version=latest&style=flat" /></a>
15+
<a href="https://github.com/sparkfun/Qwiic_SerLCD_Py/blob/master/LICENSE" alt="License">
16+
<img src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
17+
<a href="https://twitter.com/intent/follow?screen_name=sparkfun">
18+
<img src="https://img.shields.io/twitter/follow/sparkfun.svg?style=social&logo=twitter"
19+
alt="follow on Twitter"></a>
20+
</p>
21+
22+
<table class="table table-hover table-striped table-bordered">
23+
<tr align="center">
24+
<td><a href="https://www.sparkfun.com/products/16396"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/2/16396-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)"></a></td>
25+
<td><a href="https://www.sparkfun.com/products/16397"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/3/16397-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 16x2 - RGB Text (QWIIC)"></a></td>
26+
<td><a href="https://www.sparkfun.com/products/16398"><img src="https://cdn.sparkfun.com//assets/parts/1/5/1/2/4/16398-SparkFun_16x2_SerLCD_-_RGB_Backlight__Qwiic_-05.jpg" title="SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)"></a></td>
27+
</tr>
28+
<tr align="center">
29+
<td><i><a href="https://www.sparkfun.com/products/16396">SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)</a></i></td>
30+
<td><i><a href="https://www.sparkfun.com/products/16397">SparkFun SerLCD 16x2 - RGB Text (QWIIC)</a></i></td>
31+
<td><i><a href="https://www.sparkfun.com/products/16398">SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)</a></i></td>
32+
</tr>
33+
</table>
34+
35+
## Overview
36+
This bundle provides the library [Qwiic_SerLCD_Py](https://github.com/sparkfun/Qwiic_SerLCD_Py): Python module for I2C control of the SparkFun Qwiic Serial LCDs.
37+
38+
This bundling repository is a hard fork of the [CircuitPython Community Bundle](https://github.com/adafruit/CircuitPython_Community_Bundle/tree/main/libraries) and uses their build scripts to generate and release the bundle.
39+
40+
## Updating
41+
To update this bundle, publish a release/tag in the [Qwiic_SerLCD_Py](https://github.com/sparkfun/Qwiic_SerLCD_Py) repo and then run the update-submodules.sh script in this repository locally and then push.
42+
43+
## Building
44+
This bundle will be automatically built and released by GithHub workflows when you push to this repository. To build it locally:
245

3-
[![Doc Status](https://readthedocs.org/projects/circuitpython/badge/?version=latest)](https://circuitpython.readthedocs.io/en/latest/docs/drivers.html) [![Discord](https://img.shields.io/discord/327254708534116352.svg)](https://adafru.it/discord)
4-
5-
![Blinka Community](https://github.com/adafruit/CircuitPython_Community_Bundle/blob/main/adafruit_circuitpython_community_bundle_100_large.png)
6-
7-
This repo bundles a bunch of useful CircuitPython libraries into an easy to
8-
download zip file. CircuitPython boards can ship with the contents of the zip to
9-
make it easy to provide a lot of libraries by default.
10-
11-
# License
12-
Each included library has its own license that must allow for redistribution. To
13-
save space, license text is not included in the bundle. However, a link to each
14-
individual repository is which should provide source code access and license
15-
information.
16-
17-
# Use
18-
To use the bundle download the zip (not source zip) from the
19-
[latest release](https://github.com/adafruit/CircuitPython_Community_Bundle/releases/latest),
20-
unzip it and copy over the subfolders, such as `lib`, into the root of your
21-
CircuitPython device. Make sure to indicate that it should be merged with the
22-
existing folder when it exists.
23-
24-
# Development
25-
26-
After you clone this repository you must run `git submodule init` on update
27-
also do `git submodule update`.
28-
29-
## Updating libraries
30-
To update the libraries run `update-submodules.sh`. The script will fetch the
31-
latest code and update to the newest tag (not master).
32-
33-
## Adding a library
34-
Determine the best location within `libraries` for the new library and then run:
35-
36-
git submodule add <git url> libraries/<target directory>
37-
38-
The target directory should omit any MicroPython or CircuitPython specific
39-
prefixes such as `CircuitPython_` to simplify the listing.
40-
41-
You should make sure that the git url has the format `https://github.com/{:user}/{:repo}.git`,
42-
such as `https://github.com/tannewt/CircuitPython_Example.git`. Other forms may interfere with
43-
adabot scripts (see https://github.com/adafruit/adabot/issues/145 for details).
44-
45-
The repository must have a tag, as the bundle release process pulls the latest tag, usually
46-
matching a release of your library. The tag must follow the Semver format (such as *1.2.3*).
47-
48-
The [circuitpython_community_library_list.md](circuitpython_community_library_list.md) page is
49-
manually updated. Please add your library to the list with the relevant links to the repository,
50-
pypi page and documentation if available.
51-
52-
## Removing a library
53-
Only do this if you are replacing the module with an equivalent:
54-
55-
git submodule deinit libraries/<target directory>
56-
git rm libraries/<target directory>
57-
58-
## Building the bundle
5946
To build this bundle locally you'll need to install the
6047
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
6148

README.txt

Lines changed: 0 additions & 2 deletions
This file was deleted.
-173 KB
Binary file not shown.

build.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,4 +32,4 @@ gawk -F '\n' '{ match($1, /(drivers|helpers)\/(.+)\/(.+)\:/, arr) ; if (length(a
3232
gawk '{ trimmed = substr($0, 1, length($0) - 2) ; print "\"" trimmed "\"" }'
3333
)
3434

35-
circuitpython-build-bundles --filename_prefix circuitpython-community-bundle --library_location libraries --library_depth 2 --package_folder_prefix "$P"
35+
circuitpython-build-bundles --filename_prefix qwiic-serlcd-circup-bundle --library_location libraries --library_depth 2 --package_folder_prefix "$P"

0 commit comments

Comments
 (0)