A Python package that simplifies the use of secrets in a Jupyter notebook
IPython Secrets ===============
|PyPI version| |Doc Status| |License| |Supported Python|
IPython Secrets makes it easier to use secrets in a Jupyter notebook.
The first time get_secret is called, it prompts the user for the password or other secret. After this value is read, it is saved in the system keyring, and the Jupyter output cell is then cleared.
|gif1|
Subsequent calls to `get_secret use the saved value. This is true even if they are called in a different process running in the same account -- for example, if the machine has been rebooted, or the local Jupyter server has otherwise been shut down and restarted.
|gif2|
.. note:: Install the gsheet-keyring package_ to use ipython-secrets on Google Colaboratory_: pip3 install gsheet-keyring. The gsheet-keyring package provides a Keyring backend that is backed by Google Sheets. This is necessary since the Colaboratory environment doesn't provide a persistent file system, or the OS services that the Keyring's standard and alternative backends rely on.
.. warning:: This package stores the secret on the Jupyter server. Don't trust it with secrets you don't trust the Jupyter server with. (This is true for all means of using a secret in a notebook.)
.. warning:: The package is intended to reduce the likelihood of accidental disclosure of secrets in notebook source. It won't secure a secret from code that is running in the notebook; and it won't keep you from writing code that displays the secret in a notebook output cell -- in which case it has been disclosed to whoever can see the notebook.
Install
.. code:: bash
pip3 install ipython-secrets
Usage
.. code:: python
from ipython_secrets import *
TWILIOAPIKEY = getsecret('TWILIOAPI_KEY')
Alternatives
Secrets can also be stored in an environment variable, and read from the notebook. This is a best practice for applications (and especially web and other server-side services`_), but I've found it inconvenient for notebooks -- the notebook server must be re-started to pick up a new environment variable; and, it complicates the setup instructions for notebook users.
Development
Install Pipenv, and required packages:
.. code:: bash
$ pip3 install pipenv $ pipenv install $ pipenv shell $ pip install flit
Install locally:
.. code:: bash
flit install --symlink
Acknowledgements
This package is a thin wrapper around Keyring_.
License
MIT
.. |PyPI version| image:: https://img.shields.io/pypi/v/ipython-secrets.svg :target: https://pypi.python.org/pypi/ipython-secrets :alt: Latest PyPI Version .. |Doc Status| image:: https://readthedocs.org/projects/ipython-secrets/badge/?version=latest :target: http://ipython-secrets.readthedocs.io/en/latest/?badge=latest :alt: Documentation Status .. |License| image:: https://img.shields.io/pypi/l/ipython-secrets.svg :target: https://pypi.python.org/pypi/ipython-secrets :alt: License .. |Supported Python| image:: https://img.shields.io/pypi/pyversions/ipython-secrets.svg :target: https://pypi.python.org/pypi/ipython-secrets :alt: Supported Python Versions
.. API documentation: http://ipython-secrets.readthedocs.io/en/latest/?badge=latest#module-ipythonsecrets
.. |gif1| image:: ./docs/images/first-time.gif .. |gif2| image:: ./docs/images/next-time.gif
.. _Google Colaboratory: https://colab.research.google.com/ .. _Hydrogen: https://nteract.io/atom .. _Keyring: https://pypi.python.org/pypi/keyring .. _Nteract: https://nteract.io .. _server-side services: https://12factor.net/ .. _gsheet-keyring package: https://pypi.org/project/gsheet-keyring/
