Skip to content

Commit fd74ea7

Browse files
stitchesnburnsstitchesnburns
committed
Merge branch 'master' into stitchesnburns-patch-1
2 parents 8291727 + 45496d2 commit fd74ea7

File tree

8 files changed

+168
-82
lines changed

8 files changed

+168
-82
lines changed

‎.github/workflows/build.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Build CI
2+
3+
on: [pull_request, push]
4+
5+
jobs:
6+
test:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- name: Dump GitHub context
10+
env:
11+
GITHUB_CONTEXT: ${{ toJson(github) }}
12+
run: echo "$GITHUB_CONTEXT"
13+
- name: Translate Repo Name For Build Tools filename_prefix
14+
id: repo-name
15+
run: |
16+
echo ::set-output name=repo-name::$(
17+
echo ${{ github.repository }} |
18+
awk -F '\/' '{ print tolower($2) }' |
19+
tr '_' '-'
20+
)
21+
- name: Set up Python 3.6
22+
uses: actions/setup-python@v1
23+
with:
24+
python-version: 3.6
25+
- name: Versions
26+
run: |
27+
python3 --version
28+
- name: Checkout Current Repo
29+
uses: actions/checkout@v1
30+
with:
31+
submodules: true
32+
- name: Checkout tools repo
33+
uses: actions/checkout@v2
34+
with:
35+
repository: adafruit/actions-ci-circuitpython-libs
36+
path: actions-ci
37+
- name: Install deps
38+
run: |
39+
source actions-ci/install.sh
40+
- name: Library version
41+
run: git describe --dirty --always --tags
42+
- name: PyLint
43+
run: |
44+
pylint $( find . -path './adafruit*.py' )
45+
([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
46+
- name: Build assets
47+
run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
48+
- name: Build docs
49+
working-directory: docs
50+
run: sphinx-build -E -W -b html . _build/html

‎.github/workflows/release.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
name: Release Actions
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
jobs:
8+
upload-release-assets:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Dump GitHub context
12+
env:
13+
GITHUB_CONTEXT: ${{ toJson(github) }}
14+
run: echo "$GITHUB_CONTEXT"
15+
- name: Translate Repo Name For Build Tools filename_prefix
16+
id: repo-name
17+
run: |
18+
echo ::set-output name=repo-name::$(
19+
echo ${{ github.repository }} |
20+
awk -F '\/' '{ print tolower($2) }' |
21+
tr '_' '-'
22+
)
23+
- name: Set up Python 3.6
24+
uses: actions/setup-python@v1
25+
with:
26+
python-version: 3.6
27+
- name: Versions
28+
run: |
29+
python3 --version
30+
- name: Checkout Current Repo
31+
uses: actions/checkout@v1
32+
with:
33+
submodules: true
34+
- name: Checkout tools repo
35+
uses: actions/checkout@v2
36+
with:
37+
repository: adafruit/actions-ci-circuitpython-libs
38+
path: actions-ci
39+
- name: Install deps
40+
run: |
41+
source actions-ci/install.sh
42+
- name: Build assets
43+
run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location .
44+
- name: Upload Release Assets
45+
# the 'official' actions version does not yet support dynamically
46+
# supplying asset names to upload. @csexton's version chosen based on
47+
# discussion in the issue below, as its the simplest to implement and
48+
# allows for selecting files with a pattern.
49+
# https://github.com/actions/upload-release-asset/issues/4
50+
#uses: actions/[email protected]
51+
uses: csexton/release-asset-action@master
52+
with:
53+
pattern: "bundles/*"
54+
github-token: ${{ secrets.GITHUB_TOKEN }}
55+
56+
upload-pypi:
57+
runs-on: ubuntu-latest
58+
steps:
59+
- uses: actions/checkout@v1
60+
- name: Check For setup.py
61+
id: need-pypi
62+
run: |
63+
echo ::set-output name=setup-py::$( find . -wholename './setup.py' )
64+
- name: Set up Python
65+
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
66+
uses: actions/setup-python@v1
67+
with:
68+
python-version: '3.x'
69+
- name: Install dependencies
70+
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
71+
run: |
72+
python -m pip install --upgrade pip
73+
pip install setuptools wheel twine
74+
- name: Build and publish
75+
if: contains(steps.need-pypi.outputs.setup-py, 'setup.py')
76+
env:
77+
TWINE_USERNAME: ${{ secrets.pypi_username }}
78+
TWINE_PASSWORD: ${{ secrets.pypi_password }}
79+
run: |
80+
python setup.py sdist
81+
twine upload dist/*

‎.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ __pycache__
44
_build
55
*.pyc
66
.env
7-
build*
87
bundles
98
*.DS_Store
109
.eggs

‎.travis.yml

Lines changed: 0 additions & 32 deletions
This file was deleted.

‎README.rst

Lines changed: 30 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Introduction
1010
:target: https://discord.gg/nBQh6qu
1111
:alt: Discord
1212
13-
.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Fingerprint.svg?branch=master
14-
:target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_Fingerprint
13+
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/workflows/Build%20CI/badge.svg
14+
:target: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/actions/
1515
:alt: Build Status
1616

1717
This library will let you use an Adafruit Fingerprint sensor on any UART to get, store, retreive and query fingerprints! Great for adding bio-sensing security to your next build.
@@ -26,69 +26,52 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2626
This is easily achieved by downloading
2727
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2828

29-
Usage Example
30-
=============
31-
32-
See 'examples' folder for full usage demo!
29+
Installing from PyPI
30+
====================
3331

34-
API Reference
35-
=============
36-
37-
.. toctree::
38-
:maxdepth: 2
39-
40-
api
32+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
33+
PyPI <https://pypi.org/project/adafruit-circuitpython-fingerprint/>`_. To install for current user:
4134

42-
Contributing
43-
============
44-
45-
Contributions are welcome! Please read our `Code of Conduct
46-
<https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/blob/master/CODE_OF_CONDUCT.md>`_
47-
before contributing to help this project stay welcoming.
35+
.. code-block:: shell
4836
49-
Building locally
50-
================
37+
pip3 install adafruit-circuitpython-fingerprint
5138
52-
To build this library locally you'll need to install the
53-
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
39+
To install system-wide (this may be required in some cases):
5440

5541
.. code-block:: shell
5642
57-
python3 -m venv .env
58-
source .env/bin/activate
59-
pip install circuitpython-build-tools
43+
sudo pip3 install adafruit-circuitpython-fingerprint
6044
61-
Once installed, make sure you are in the virtual environment:
45+
To install in a virtual environment in your current project:
6246

6347
.. code-block:: shell
6448
49+
mkdir project-name && cd project-name
50+
python3 -m venv .env
6551
source .env/bin/activate
52+
pip3 install adafruit-circuitpython-fingerprint
6653
67-
Then run the build:
68-
69-
.. code-block:: shell
70-
71-
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-fingerprint --library_location .
54+
Usage Example
55+
=============
7256

73-
Sphinx documentation
74-
-----------------------
57+
See 'examples' folder for full usage demo!
7558

76-
Sphinx is used to build the documentation based on rST files and comments in the code. First,
77-
install dependencies (feel free to reuse the virtual environment from above):
59+
API Reference
60+
=============
7861

79-
.. code-block:: shell
62+
.. toctree::
63+
:maxdepth: 2
8064

81-
python3 -m venv .env
82-
source .env/bin/activate
83-
pip install Sphinx sphinx-rtd-theme
65+
api
8466

85-
Now, once you have the virtual environment activated:
67+
Contributing
68+
============
8669

87-
.. code-block:: shell
70+
Contributions are welcome! Please read our `Code of Conduct
71+
<https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/blob/master/CODE_OF_CONDUCT.md>`_
72+
before contributing to help this project stay welcoming.
8873

89-
cd docs
90-
sphinx-build -E -W -b html . _build/html
74+
Documentation
75+
=============
9176

92-
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
93-
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
94-
locally verify it will pass.
77+
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.

‎examples/fingerprint_simpletest.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@
1010

1111
#uart = busio.UART(board.TX, board.RX, baudrate=57600)
1212

13-
# If using with a computer such as Linux/RaspberryPi, Mac, Windows...
13+
# If using with a computer such as Linux/RaspberryPi, Mac, Windows with USB/serial converter:
1414
#import serial
1515
#uart = serial.Serial("/dev/ttyUSB0", baudrate=57600, timeout=1)
1616
uart = serial.Serial("/dev/ttyAMA0", baudrate=57600, timeout=1)
1717

18+
# If using with Linux/Raspberry Pi and hardware UART:
19+
#import serial
20+
#uart = serial.Serial("/dev/ttyS0", baudrate=57600, timeout=1)
21+
1822
finger = adafruit_fingerprint.Adafruit_Fingerprint(uart)
1923

2024
##################################################

‎requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
Adafruit-Blinka
2+
pyserial

‎setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
author='Adafruit Industries',
3535
author_email='[email protected]',
3636

37-
install_requires=['Adafruit-Blinka'],
37+
install_requires=['Adafruit-Blinka', 'pyserial'],
3838

3939
# Choose your license
4040
license='MIT',

0 commit comments

Comments
 (0)