Skip to content

An extension for ScreenPy that enables interacting with PyOTP.

License

Notifications You must be signed in to change notification settings

ScreenPyHQ/screenpy_pyotp

Repository files navigation

ScreenPy PyOTP

Build Status Build Status

Supported Versions Checked with mypy Code style: black Imports: isort Ruff

TITLE CARD:
                                "ScreenPy PyOTP"
TITLE DISAPPEARS.
                                                                      FADE IN:
EXT. DOCUMENTATION - MIDNIGHT

AUDIENCE continues walking, guided by the mysterious voice of the NARRATOR.
AUDIENCE winds through a garden of large hedges, twisting past brambles,
until they arrive at a single large, glowing lock upon a pedestal.


                              NARRATOR (V.O.)
            ... and you have arrived at ScreenPy PyOTP, an
            extension which enables using One Time Passwords.

                              AUDIENCE
            Wait, how long has it been since I met you? How is this
            pedestal glowing like that? And what, there's only one
            tchotchke this time?

                              NARRATOR (V.O.)
            Extensions do not need to be all that large to enable
            great things. This library provides only the Ability
            an Actor needs for two-factor authentication.

                              AUDIENCE
            You always seem to ignore the questions I most want the
            answers to.

                              NARRATOR (V.O.)
            Continuing along, to your left...

                                                                      FADE OUT

Installation

pip install screenpy_pyotp

or

pip install screenpy[pyotp]

Documentation

Please check out the Read The Docs documentation for the latest information about this module!

You can also read the ScreenPy Docs for more information about ScreenPy in general.

Contributing

You want to contribute? Great! Here are the things you should do before submitting your PR:

  1. Fork the repo and git clone your fork.
  2. dev install the project package:
    1. pip install -e .[dev]
    2. Optional (poetry users):
      1. poetry install --extras dev
  3. Run pre-commit install once.
  4. Run tox to perform tests frequently.
  5. Create pull-request from your branch.

That's it! :)

About

An extension for ScreenPy that enables interacting with PyOTP.

Resources

License

Stars

Watchers

Forks

Packages

No packages published