https://github.com/devunt/uotp

μOTP+ is the next generation OTP toolkit.
https://github.com/devunt/uotp

otp

Last synced: about 2 months ago
JSON representation

μOTP+ is the next generation OTP toolkit.

• Host: GitHub
• URL: https://github.com/devunt/uotp
• Owner: devunt
• License: unlicense
• Created: 2017-08-28T17:04:19.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-23T11:22:05.000Z (about 7 years ago)
• Last Synced: 2024-11-05T06:05:25.945Z (about 2 months ago)
• Topics: otp
• Language: Python
• Homepage: https://pypi.org/project/uotp/
• Size: 31.3 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
*****

μOTP+

*****

μOTP+ is the next generation OTP toolkit.

Installation

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

You will need Python 3.4 or higher in order to run ``uotp``.

.. code-block:: console

  $ pip install -U uotp

How to use μOTP+ as GUI application

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

Run ``uotp gui``.

.. code-block:: console

  $ uotp gui

How to use μOTP+ as CLI application

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

Just run ``uotp``.

.. code-block:: console

  $ uotp

μOTP+ will automatically issue a new account and sync time with the server for you.

Once you have successfully issued the new account, running ``uotp`` again will start giving you the OTP token.

For more information, see ``uotp --help``.

Configuration file

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

By default, a new configuration file will be automatically generated on ``~/.config/uotp/config.yml``.

This behaviour however can be overriden by passing ``--conf=/path/to/config.yml`` to ``uotp`` command or setting ``UOTP_CONF=/path/to/config.yml`` environment variable.

.. code-block:: console

  $ uotp --conf=uotp.yml new

  $ UOTP_CONF=uotp.yml uotp new

How to develop an application using μOTP+

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

.. code-block:: python

  # Import everything

  from uotp import UOTP

  # Create an instance of UOTP

  uotp = UOTP

  # Issue a new account

  uotp.issue_account()

  print('S/N: ', uotp.account_serial_number)

  # Sync time with the server

  uotp.sync_time()

  # Get a new OTP token

  token = uotp.generate_token()

  print('Token: ', token)

License

=======

All proprietary materials are intellectual property of (C) 2004 - 2017 ATsolutions