Skip to content

Commit 285f5fe

Browse files
committed
Rename to circuitpython-build-tools because it does work locally with a compiler.
1 parent afc8951 commit 285f5fe

File tree

2 files changed

+14
-13
lines changed

2 files changed

+14
-13
lines changed

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,20 @@
44

55
This repo contains build scripts used to build the
66
[Adafruit CircuitPython bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle), [CircuitPython Community bundle](https://github.com/adafruit/CircuitPython_Community_Bundle)
7-
and individual library release zips on Travis CI.
7+
and individual library release zips. Its focused on Travis CI support but will also work locally
8+
when a gcc compiler is present.
89

9-
The pip package includes mpy-crosses that run on Travis. They will likely not
10-
work in other environments.
10+
The pip package includes mpy-crosses that run on Travis. When building locally, the scripts will
11+
automatically clone the [CircuitPython repo](https://github.com/adafruit/circuitpython) and attempt
12+
to build mpy-crosses. You'll need some version of gcc for this to work.
1113

1214
## Setting up libraries
1315

1416
These build tools are intended for use with [Travis CI](https://travis-ci.org)
1517
to automatically build .mpy files and zip them up for CircuitPython when a new
16-
tagged release is created. This file is relatively generic and can be shared
17-
across multiple repositories by following these steps:
18+
tagged release is created. To add support to a repo you need to:
1819

19-
1. Use the [CircuitPython cookiecutter](https://github.com/adafruit/cookiecutter-adafruit-circuitpython) to generate .travis.yml and requirements.txt.
20+
1. Use the [CircuitPython cookiecutter](https://github.com/adafruit/cookiecutter-adafruit-circuitpython) to generate .travis.yml.
2021
2. For adafruit repositories, simply give the CircuitPythonLibrarians team
2122
write access to the repo and Adabot will do the rest.
2223

@@ -34,24 +35,24 @@ across multiple repositories by following these steps:
3435
Add an environment variable named GITHUB_TOKEN and set it to the value
3536
of the GitHub personal access token above. Keep 'Display value in build
3637
log' flipped off.
37-
5. That's it! Tag a release and Travis should go to work to add .mpy files
38+
5. That's it! Tag a release and Travis should go to work to add zipped .mpy files
3839
to the release. It takes about a 2-3 minutes for a worker to spin up,
3940
build mpy-cross, and add the binaries to the release.
4041

4142
The bundle build will produce one zip file for every major CircuitPython
42-
release containing compatible mpy files and a zip with human readable py files.
43+
release supported containing compatible mpy files and a zip with human readable py files.
4344
It'll also "release" a `z-build_tools_version-x.x.x.ignore` file that will be
4445
used to determine when a library needs new release files because the build tools
45-
themselves changed such as when a new major CircuitPython release happens.
46+
themselves changed, such as when a new major CircuitPython release happens.
4647

4748
## Building libraries locally
4849

4950
To build libraries built with the build tools you'll need to install the
50-
circuitpython-travis-build-tools package.
51+
circuitpython-build-tools package.
5152

5253
```shell
5354
python3 -m venv .env
5455
source .env/bin/activate
55-
pip install -r requirements.txt
56+
pip install circuitpython-build-tools
5657
circuitpython-build-bundles --filename_prefix <output file prefix> --library_location .
5758
```

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22

33
from setuptools import setup
44

5-
setup(name='circuitpython-travis-build-tools',
5+
setup(name='circuitpython-build-tools',
66
use_scm_version=True,
77
setup_requires=["setuptools_scm"],
8-
description='CircuitPython library build tools for Travis CI',
8+
description='CircuitPython library build tools',
99
author='Scott Shawcroft',
1010
author_email='[email protected]',
1111
url='https://www.adafruit.com/',

0 commit comments

Comments
 (0)