gsheet-keyring 1.0.0

This package provides a Keyring backend that is backed by a Google Sheet.

This package provides a Keyring backend that stores passwords in a Google Sheet. It was created for use with the ipython-secrets package, that uses Kerying to store secrets that are used in a Jupyter notebook. This package extends ipython-secret’s functionality, to enable it to be used in Colaboratory notebooks, and other hosted services that don’t support the standard Keyring backends.

The Python Keyring package is a cross-platform password storage library, that supports a variety of platform-specific backends, as well as a few third-party backends.

None of these other backends is compatible with Google Colaboratory. (They may not be compatible with other Jupyter hosting services such as Azure or CoCalc, either.) That’s the problem that this package solves.

To use this package, install it via pip3 install gsheet-keyring, and use the Keyring API as normal. If one of the built-in Keyring backends is available, Keyring will use that. If a platform-specific backend is not available, Keyring will automatically detect and use this package instead.

Use keyring.set_keyring to force Keyring to use this package even if other backends are available:

import keyring
from gsheet_keyring import GoogleSheetKeyring
keyring.set_keyring(GoogleSheetKeyring())

By default, this searches for a Google Sheet named “keyring”. If there’s no sheet with this name, one is created.

As an alternative, you may also specify a different Google Sheet name, a Google Sheet key, or a Worksheet from the gspread package.

License

MIT