https://github.com/Kami/python-yubico-client

Python library for validating Yubico Yubikey One Time Passwords (OTPs) based on the validation protocol version 2.0.
https://github.com/Kami/python-yubico-client

Last synced: about 1 month ago
JSON representation

Python library for validating Yubico Yubikey One Time Passwords (OTPs) based on the validation protocol version 2.0.

• Host: GitHub
• URL: https://github.com/Kami/python-yubico-client
• Owner: Kami
• License: other
• Created: 2010-05-04T20:19:03.000Z (over 14 years ago)
• Default Branch: master
• Last Pushed: 2022-09-07T16:57:01.000Z (about 2 years ago)
• Last Synced: 2024-07-07T15:22:51.492Z (2 months ago)
• Language: Python
• Homepage: https://yubico-client.readthedocs.org/en/latest/
• Size: 195 KB
• Stars: 84
• Watchers: 6
• Forks: 19
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Yubico Python Client

====================

.. image:: https://img.shields.io/pypi/v/yubico-client.svg

    :target: https://pypi.python.org/pypi/yubico-client/

.. image:: https://img.shields.io/pypi/dm/yubico-client.svg

        :target: https://pypi.python.org/pypi/yubico-client/

.. image:: https://secure.travis-ci.org/Kami/python-yubico-client.png?branch=master

        :target: http://travis-ci.org/Kami/python-yubico-client

.. image:: https://img.shields.io/codecov/c/github/Kami/python-yubico-client/master.svg

        :target: https://codecov.io/github/Kami/python-yubico-client?branch=master

.. image:: https://img.shields.io/pypi/pyversions/yubico-client.svg

        :target: https://pypi.python.org/pypi/yubico-client/

.. image:: https://img.shields.io/pypi/wheel/yubico-client.svg

        :target: https://pypi.python.org/pypi/yubico-client/

.. image:: https://img.shields.io/github/license/Kami/python-yubico-client.svg

        :target: https://github.com/Kami/python-yubico-client/blob/trunk/LICENSE

Python class for verifying Yubico One Time Passwords (OTPs) based on the

validation protocol version 2.0.

* Yubico website: http://www.yubico.com

* Yubico documentation: http://www.yubico.com/developers/intro/

* Validation Protocol Version 2.0 description: https://developers.yubico.com/yubikey-val/Validation_Protocol_V2.0.html

For more information and usage examples, please see the.

`documentation `_.

Documentation

-------------

Documentation is available at https://yubico-client.readthedocs.org/en/latest/

Installation

------------

.. code-block:: bash

    $ pip install yubico-client

Note: Package has been recently renamed from `yubico` to `yubico-client` and

the main module has been renamed from `yubico` to `yubico_client`. This

was done to avoid naming conflicts and make creation of distribution specific

packages easier.

Quick Start / Usage

-------------------

.. code-block:: python

    from yubico_client import Yubico

    client = Yubico('client id', 'secret key')

    client.verify('otp')

For more information and detailed examples, please refer to the

documentation - https://yubico-client.readthedocs.io/en/latest/.

Supported Python Versions

-------------------------

* Python 2.7

* Python 3.4

* Python 3.5

* Python 3.6

* Python 3.7

* Python 3.8

* PyPy 2

* PyPy 3

Running Tests

-------------

To run the tests use the tox command. This will automatically run the tests on

all the supported Python versions.

.. code-block:: bash

    $ tox

License

-------

Yubico Client is distributed under the `3-Clause BSD License`_.

.. _`3-Clause BSD License`: http://opensource.org/licenses/BSD-3-Clause