Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fingerprint/badge/?version=latest
:target: https://docs.circuitpython.org/projects/fingerprint/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
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.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
====================
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-fingerprint/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-fingerprint
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-fingerprint
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-fingerprint
Usage Example
=============
See 'examples' folder for full usage demo!
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fingerprint/en/latest/>`_.
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>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-fingerprint",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, uart, fingerprint, finger, print, sensor, hardware, micropython, circuitpython",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/92/92/97b1856fb2206f4230056bc7c69fc1088488a3de85cf5de77e918a5a6245/adafruit_circuitpython_fingerprint-2.2.17.tar.gz",
"platform": null,
"description": "\nIntroduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-fingerprint/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/fingerprint/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nThis 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.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n====================\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-fingerprint/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-fingerprint\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-fingerprint\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-fingerprint\n\nUsage Example\n=============\n\nSee 'examples' folder for full usage demo!\n\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/fingerprint/en/latest/>`_.\n\nFor 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>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "CircuitPython library for UART fingerprint sensor.",
"version": "2.2.17",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Fingerprint"
},
"split_keywords": [
"adafruit",
" uart",
" fingerprint",
" finger",
" print",
" sensor",
" hardware",
" micropython",
" circuitpython"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d668e5694756a019bc9731f7db9d1bf7facb90599656694c5c11479ed85435f",
"md5": "1c0c61a7fe61498ee0cc25b29e2f9b26",
"sha256": "818fadcc05d74cdc106caeab59ca0e84a213275ec8101652979f6c682ac40c10"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fingerprint-2.2.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c0c61a7fe61498ee0cc25b29e2f9b26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8359,
"upload_time": "2024-11-02T21:37:35",
"upload_time_iso_8601": "2024-11-02T21:37:35.230166Z",
"url": "https://files.pythonhosted.org/packages/0d/66/8e5694756a019bc9731f7db9d1bf7facb90599656694c5c11479ed85435f/adafruit_circuitpython_fingerprint-2.2.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "929297b1856fb2206f4230056bc7c69fc1088488a3de85cf5de77e918a5a6245",
"md5": "e3a2cb2eb114b32c250246bd486a2942",
"sha256": "705dbf01df983126121b560f447540db08236d65a22ee9039f30c773311f65d5"
},
"downloads": -1,
"filename": "adafruit_circuitpython_fingerprint-2.2.17.tar.gz",
"has_sig": false,
"md5_digest": "e3a2cb2eb114b32c250246bd486a2942",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 35375,
"upload_time": "2024-11-02T21:37:36",
"upload_time_iso_8601": "2024-11-02T21:37:36.557282Z",
"url": "https://files.pythonhosted.org/packages/92/92/97b1856fb2206f4230056bc7c69fc1088488a3de85cf5de77e918a5a6245/adafruit_circuitpython_fingerprint-2.2.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-02 21:37:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Fingerprint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "adafruit-circuitpython-fingerprint"
}
JSON
