No description
Find a file
jerryneedell c8acb3f9df
Merge pull request #16 from Tasm-Devil/master
remove the flush=True argument
2019-02-03 12:20:47 -05:00
adafruit_pn532 ok, fine, if you insist 2018-08-28 13:26:02 -07:00
docs read the docs 2018-08-28 13:05:21 -07:00
examples remove the flush=True argument 2019-02-03 14:45:24 +01:00
.gitignore cookie 2018-08-25 01:45:47 -04:00
.pylintrc cookie 2018-08-25 01:45:47 -04:00
.readthedocs.yml cookie 2018-08-25 01:45:47 -04:00
.travis.yml now for you lint lint cool j 2018-08-28 13:11:43 -07:00
CODE_OF_CONDUCT.md cookie 2018-08-25 01:45:47 -04:00
LICENSE cookie 2018-08-25 01:45:47 -04:00
README.rst change 'travis-ci.org' to 'travis-ci.com' 2018-12-21 13:29:39 -06:00
requirements.txt Pylint, doc, and better raspi support 2018-08-25 20:39:16 +00:00
setup.py setup.py update 2018-12-10 17:11:03 -05:00

Introduction
============

.. image:: https://readthedocs.org/projects/adafruit-circuitpython-pn532/badge/?version=latest
    :target: https://circuitpython.readthedocs.io/projects/pn532/en/latest/
    :alt: Documentation Status

.. image:: https://img.shields.io/discord/327254708534116352.svg
    :target: https://discord.gg/nBQh6qu
    :alt: Discord

.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_PN532.svg?branch=master
    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_PN532
    :alt: Build Status

CircuitPython driver for the `PN532 NFC/RFID Breakout <https://www.adafruit.com/product/364>`_ and `PN532 NFC/RFID Shield <https://www.adafruit.com/product/789>`_

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

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

.. code-block:: shell

    pip3 install adafruit-circuitpython-pn532

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

.. code-block:: shell

    sudo pip3 install adafruit-circuitpython-pn532

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .env
    source .env/bin/activate
    pip3 install adafruit-circuitpython-pn532

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

Check examples/pn532_simpletest.py for usage example

Contributing
============

Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/adafruit_CircuitPython_PN532/blob/master/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.

Building locally
================

Zip release files
-----------------

To build this library locally you'll need to install the
`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install circuitpython-build-tools

Once installed, make sure you are in the virtual environment:

.. code-block:: shell

    source .env/bin/activate

Then run the build:

.. code-block:: shell

    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-pn532 --library_location .

Sphinx documentation
-----------------------

Sphinx is used to build the documentation based on rST files and comments in the code. First,
install dependencies (feel free to reuse the virtual environment from above):

.. code-block:: shell

    python3 -m venv .env
    source .env/bin/activate
    pip install Sphinx sphinx-rtd-theme

Now, once you have the virtual environment activated:

.. code-block:: shell

    cd docs
    sphinx-build -E -W -b html . _build/html

This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
locally verify it will pass.