-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #10 from pimoroni/repackage
Repackage to hatch/pyproject.toml
- Loading branch information
Showing
28 changed files
with
777 additions
and
671 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
name: Build | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
test: | ||
name: Python ${{ matrix.python }} | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python: ['3.9', '3.10', '3.11'] | ||
|
||
env: | ||
RELEASE_FILE: ${{ github.event.repository.name }}-${{ github.event.release.tag_name || github.sha }}-py${{ matrix.python }} | ||
|
||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python ${{ matrix.python }} | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: ${{ matrix.python }} | ||
|
||
- name: Install Dependencies | ||
run: | | ||
make dev-deps | ||
- name: Build Packages | ||
run: | | ||
make build | ||
- name: Upload Packages | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: ${{ env.RELEASE_FILE }} | ||
path: dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
name: QA | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches: | ||
- main | ||
|
||
jobs: | ||
test: | ||
name: linting & spelling | ||
runs-on: ubuntu-latest | ||
env: | ||
TERM: xterm-256color | ||
|
||
steps: | ||
- name: Checkout Code | ||
uses: actions/checkout@v4 | ||
|
||
- name: Set up Python '3,11' | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: '3.11' | ||
|
||
- name: Install Dependencies | ||
run: | | ||
make dev-deps | ||
- name: Run Quality Assurance | ||
run: | | ||
make qa | ||
- name: Run Code Checks | ||
run: | | ||
make check | ||
- name: Run Bash Code Checks | ||
run: | | ||
make shellcheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,37 +1,41 @@ | ||
name: Python Tests | ||
name: Tests | ||
|
||
on: | ||
pull_request: | ||
push: | ||
branches: | ||
- master | ||
- main | ||
|
||
jobs: | ||
test: | ||
name: Python ${{ matrix.python }} | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
python: [2.7, 3.5, 3.7, 3.9] | ||
python: ['3.9', '3.10', '3.11'] | ||
|
||
steps: | ||
- uses: actions/checkout@v2 | ||
- name: Checkout Code | ||
uses: actions/checkout@v3 | ||
|
||
- name: Set up Python ${{ matrix.python }} | ||
uses: actions/setup-python@v2 | ||
uses: actions/setup-python@v5 | ||
with: | ||
python-version: ${{ matrix.python }} | ||
|
||
- name: Install Dependencies | ||
run: | | ||
python -m pip install --upgrade setuptools tox | ||
make dev-deps | ||
- name: Run Tests | ||
working-directory: library | ||
run: | | ||
tox -e py | ||
make pytest | ||
- name: Coverage | ||
if: ${{ matrix.python == '3.9' }} | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
working-directory: library | ||
run: | | ||
python -m pip install coveralls | ||
coveralls --service=github | ||
if: ${{ matrix.python == '3.9' }} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,9 @@ | ||
1.0.0 | ||
----- | ||
|
||
* Repackage to hatch/pyproject.toml | ||
* Migrate to smbus2 | ||
|
||
0.1.0 | ||
----- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,69 +1,66 @@ | ||
LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}') | ||
LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}') | ||
LIBRARY_NAME := $(shell hatch project metadata name 2> /dev/null) | ||
LIBRARY_VERSION := $(shell hatch version 2> /dev/null) | ||
|
||
.PHONY: usage install uninstall | ||
.PHONY: usage install uninstall check pytest qa build-deps check tag wheel sdist clean dist testdeploy deploy | ||
usage: | ||
ifdef LIBRARY_NAME | ||
@echo "Library: ${LIBRARY_NAME}" | ||
@echo "Version: ${LIBRARY_VERSION}\n" | ||
else | ||
@echo "WARNING: You should 'make dev-deps'\n" | ||
endif | ||
@echo "Usage: make <target>, where target is one of:\n" | ||
@echo "install: install the library locally from source" | ||
@echo "uninstall: uninstall the local library" | ||
@echo "check: peform basic integrity checks on the codebase" | ||
@echo "python-readme: generate library/README.md from README.md + library/CHANGELOG.txt" | ||
@echo "python-wheels: build python .whl files for distribution" | ||
@echo "python-sdist: build python source distribution" | ||
@echo "python-clean: clean python build and dist directories" | ||
@echo "python-dist: build all python distribution files" | ||
@echo "python-testdeploy: build all and deploy to test PyPi" | ||
@echo "tag: tag the repository with the current version" | ||
@echo "install: install the library locally from source" | ||
@echo "uninstall: uninstall the local library" | ||
@echo "dev-deps: install Python dev dependencies" | ||
@echo "check: perform basic integrity checks on the codebase" | ||
@echo "qa: run linting and package QA" | ||
@echo "pytest: run Python test fixtures" | ||
@echo "clean: clean Python build and dist directories" | ||
@echo "build: build Python distribution files" | ||
@echo "testdeploy: build and upload to test PyPi" | ||
@echo "deploy: build and upload to PyPi" | ||
@echo "tag: tag the repository with the current version\n" | ||
|
||
version: | ||
@hatch version | ||
|
||
install: | ||
./install.sh | ||
./install.sh --unstable | ||
|
||
uninstall: | ||
./uninstall.sh | ||
|
||
check: | ||
@echo "Checking for DOS line-endings" | ||
@! grep -lIUrn --color "" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile | ||
@echo "Checking library/CHANGELOG.txt" | ||
@cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION} | ||
@echo "Checking library/${LIBRARY_NAME}/__init__.py" | ||
@cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'" | ||
|
||
tag: | ||
git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}" | ||
dev-deps: | ||
python3 -m pip install -r requirements-dev.txt | ||
sudo apt install dos2unix shellcheck | ||
|
||
python-readme: library/README.md | ||
check: | ||
@bash check.sh | ||
|
||
python-license: library/LICENSE.txt | ||
shellcheck: | ||
shellcheck *.sh | ||
|
||
library/README.md: README.md library/CHANGELOG.txt | ||
cp README.md library/README.md | ||
printf "\n# Changelog\n" >> library/README.md | ||
cat library/CHANGELOG.txt >> library/README.md | ||
qa: | ||
tox -e qa | ||
|
||
library/LICENSE.txt: LICENSE | ||
cp LICENSE library/LICENSE.txt | ||
pytest: | ||
tox -e py | ||
|
||
python-wheels: python-readme python-license | ||
cd library; python3 setup.py bdist_wheel | ||
cd library; python setup.py bdist_wheel | ||
nopost: | ||
@bash check.sh --nopost | ||
|
||
python-sdist: python-readme python-license | ||
cd library; python setup.py sdist | ||
tag: version | ||
git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}" | ||
|
||
python-clean: | ||
-rm -r library/dist | ||
-rm -r library/build | ||
-rm -r library/*.egg-info | ||
build: check | ||
@hatch build | ||
|
||
python-dist: python-clean python-wheels python-sdist | ||
ls library/dist | ||
twine check library/dist/* | ||
clean: | ||
-rm -r dist | ||
|
||
python-testdeploy: check python-dist | ||
twine upload --repository-url https://test.pypi.org/legacy/ library/dist/* | ||
testdeploy: build | ||
twine upload --repository testpypi dist/* | ||
|
||
python-deploy: check python-dist | ||
twine upload library/dist/* | ||
deploy: nopost build | ||
twine upload dist/* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,51 @@ | ||
# AS7262 Spectral Sensor | ||
|
||
[![Build Status](https://shields.io/github/workflow/status/pimoroni/as7262-python/Python%20Tests.svg)](https://github.com/pimoroni/as7262-python/actions/workflows/test.yml) | ||
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/as7262-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/as7262-python?branch=master) | ||
[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/as7262-python/test.yml?branch=main)](https://github.com/pimoroni/as7262-python/actions/workflows/test.yml) | ||
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/as7262-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/as7262-python?branch=main) | ||
[![PyPi Package](https://img.shields.io/pypi/v/as7262.svg)](https://pypi.python.org/pypi/as7262) | ||
[![Python Versions](https://img.shields.io/pypi/pyversions/as7262.svg)](https://pypi.python.org/pypi/as7262) | ||
|
||
|
||
Suitable for detecting the properties of ambient light, light passing through a liquid or light reflected from an object the AS7262 spectral sensor has 6 spectral channels at 450 (violet), 500 (blue), 550 (green), 570 (yellow), 600 (orange) and 650nm (red). | ||
|
||
# Installing | ||
## Installing | ||
|
||
### Full install (recommended): | ||
|
||
We've created an easy installation script that will install all pre-requisites and get your AS7262 | ||
up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal | ||
on your Raspberry Pi desktop, as illustrated below: | ||
|
||
![Finding the terminal](http://get.pimoroni.com/resources/github-repo-terminal.png) | ||
|
||
In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions: | ||
|
||
```bash | ||
git clone https://github.com/pimoroni/as7262-python | ||
cd as7262-python | ||
./install.sh | ||
``` | ||
|
||
**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples: | ||
|
||
``` | ||
source ~/.virtualenvs/pimoroni/bin/activate | ||
``` | ||
|
||
### Development: | ||
|
||
Stable library from PyPi: | ||
If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so: | ||
|
||
* Just run `python3 -m pip install as7262` | ||
```bash | ||
git clone https://github.com/pimoroni/as7262-python | ||
cd as7262-python | ||
./install.sh --unstable | ||
``` | ||
|
||
Latest/development library from GitHub: | ||
The install script should do it for you, but in some cases you might have to enable the i2c bus. | ||
|
||
* `git clone https://github.com/pimoroni/as7262-python` | ||
* `cd as7262-python` | ||
* `sudo ./install.sh --unstable` | ||
On a Raspberry Pi you can do that like so: | ||
|
||
``` | ||
sudo raspi-config nonint do_i2c 0 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.