Skip to content

Simple Python TOTP code generator that stores secrets in your keyring

License

Notifications You must be signed in to change notification settings

jjfalling/TOTP-Generator

Repository files navigation

Python Tests codecov

TOTP Generator

Simple Python TOTP code generator that stores TOTP secrets in your keyring. Install with pip install totp-generator

As of version 3 this requires python 3.7+. Version 2.x is tested to run on python 2.7 - 3.8, however this major version will not receive any updates.

Supported keyrings can be found here. You can also specify the keyring settings in a config file. Run totp_generator with the -d flag for the config root path and the current keyring service.

setproctitle is an optional dependency due permission and dependency requirements on some systems. Install with pip install totp-generator[proctitle] to install this dependancy and enable setting the process name. This feature is useful for some uses with some keyrings such as the OSX Keychain.

The clipboard function under linux does require xclip with x11 or wl-clipboard with wayland. See https://github.com/spyoungtech/pyclip/tree/main/docs#platform-specific-notesissues

Run totp_generator with the --help flag for more information.

Development

This project uses semantic versioning (major.minor.patch).

Install the test requirements with pip install ".[test]" . Run the tests with pytest (see https://github.com/jjfalling/TOTP-Generator/blob/master/.github/workflows/python-tests.yml for command).

To create a new build:

  • Bump the version in totp_generator/__init__.py
  • Run python setup.py upload
  • Add a new Github release with the git tag that setup.py created (same as the new version number).

About

Simple Python TOTP code generator that stores secrets in your keyring

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages