adafruit-circuitpython-atecc


Nameadafruit-circuitpython-atecc JSON
Version 1.2.21 PyPI version JSON
download
home_pageNone
SummaryDriver for Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage
upload_time2024-10-07 21:37:59
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseMIT
keywords adafruit blinka circuitpython micropython atecc atecc microchip secure element key co-processor
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-atecc/badge/?version=latest
    :target: https://docs.circuitpython.org/projects/atecc/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_ATECC/workflows/Build%20CI/badge.svg
    :target: https://github.com/adafruit/Adafruit_CircuitPython_ATECC/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


Driver for `Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage <https://www.adafruit.com/product/4314>`_.

Note: This library was developed and tested with an ATECC608A, but should work for ATECC508 modules as well.


Dependencies
=============
This driver depends on:

* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_

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
=====================
.. note:: This library is not available on PyPI yet. Install documentation is included
   as a standard element. Stay tuned for PyPI availability!

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-atecc/>`_. To install for current user:

.. code-block:: shell

    pip3 install adafruit-circuitpython-atecc

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-atecc

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-atecc

Usage Example
=============

Examples of using this module are in examples folder.

Documentation
=============

API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/atecc/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_ATECC/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "adafruit-circuitpython-atecc",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "adafruit, blinka, circuitpython, micropython, atecc, atecc, , microchip, , secure, , element, , key, , co-processor",
    "author": null,
    "author_email": "Adafruit Industries <circuitpython@adafruit.com>",
    "download_url": "https://files.pythonhosted.org/packages/6b/ab/5dd2458f38752ef16d45af107f34dd7b28e52cd6eb203b497c04baa4a35c/adafruit_circuitpython_atecc-1.2.21.tar.gz",
    "platform": null,
    "description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-atecc/badge/?version=latest\n    :target: https://docs.circuitpython.org/projects/atecc/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_ATECC/workflows/Build%20CI/badge.svg\n    :target: https://github.com/adafruit/Adafruit_CircuitPython_ATECC/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\n\nDriver for `Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage <https://www.adafruit.com/product/4314>`_.\n\nNote: This library was developed and tested with an ATECC608A, but should work for ATECC508 modules as well.\n\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n* `Bus Device <https://github.com/adafruit/Adafruit_CircuitPython_BusDevice>`_\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.. note:: This library is not available on PyPI yet. Install documentation is included\n   as a standard element. Stay tuned for PyPI availability!\n\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-atecc/>`_. To install for current user:\n\n.. code-block:: shell\n\n    pip3 install adafruit-circuitpython-atecc\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n    sudo pip3 install adafruit-circuitpython-atecc\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-atecc\n\nUsage Example\n=============\n\nExamples of using this module are in examples folder.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/atecc/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_ATECC/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Driver for Microchip's ATECCx08 cryptographic co-processors with secure hardware-based key storage",
    "version": "1.2.21",
    "project_urls": {
        "Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_ATECC"
    },
    "split_keywords": [
        "adafruit",
        " blinka",
        " circuitpython",
        " micropython",
        " atecc",
        " atecc",
        " ",
        " microchip",
        " ",
        " secure",
        " ",
        " element",
        " ",
        " key",
        " ",
        " co-processor"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8811dd0f02ea197ee392ea0a56259869fbb4990dc1759651080fd7e9ce40c51e",
                "md5": "e6038717a4630ee1ce5e083eacaf605d",
                "sha256": "5d25bbab9517e7258a3f74b1ec2423fad9e5fe4f8907fe0538632d5369cbe4b8"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_atecc-1.2.21-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e6038717a4630ee1ce5e083eacaf605d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 15290,
            "upload_time": "2024-10-07T21:37:57",
            "upload_time_iso_8601": "2024-10-07T21:37:57.806499Z",
            "url": "https://files.pythonhosted.org/packages/88/11/dd0f02ea197ee392ea0a56259869fbb4990dc1759651080fd7e9ce40c51e/adafruit_circuitpython_atecc-1.2.21-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6bab5dd2458f38752ef16d45af107f34dd7b28e52cd6eb203b497c04baa4a35c",
                "md5": "000e089d831a3c9238dca2476cb4ea9b",
                "sha256": "30a48ab40398cd0067c8d04a957dcfa8cf77e58575c521b304c333d3da15c6c9"
            },
            "downloads": -1,
            "filename": "adafruit_circuitpython_atecc-1.2.21.tar.gz",
            "has_sig": false,
            "md5_digest": "000e089d831a3c9238dca2476cb4ea9b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 36039,
            "upload_time": "2024-10-07T21:37:59",
            "upload_time_iso_8601": "2024-10-07T21:37:59.604526Z",
            "url": "https://files.pythonhosted.org/packages/6b/ab/5dd2458f38752ef16d45af107f34dd7b28e52cd6eb203b497c04baa4a35c/adafruit_circuitpython_atecc-1.2.21.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-07 21:37:59",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adafruit",
    "github_project": "Adafruit_CircuitPython_ATECC",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "adafruit-circuitpython-atecc"
}
        
Elapsed time: 0.37667s