Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/osteele/ipython-secrets

A Python package that simplifies the use of secrets in a Jupyter notebook
https://github.com/osteele/ipython-secrets

ipython ipython-notebook jupyter jupyter-notebook-extension keyring password-store python-package

Last synced: 25 days ago
JSON representation

A Python package that simplifies the use of secrets in a Jupyter notebook

Host: GitHub
URL: https://github.com/osteele/ipython-secrets
Owner: osteele
License: mit
Created: 2018-01-22T14:30:45.000Z (almost 7 years ago)
Default Branch: master
Last Pushed: 2021-10-21T18:34:53.000Z (about 3 years ago)
Last Synced: 2024-09-28T23:40:55.983Z (about 1 month ago)
Topics: ipython, ipython-notebook, jupyter, jupyter-notebook-extension, keyring, password-store, python-package
Language: Python
Homepage:
Size: 171 KB
Stars: 21
Watchers: 2
Forks: 1
Open Issues: 10
Metadata Files:
- Readme: README.rst
- License: LICENSE

Awesome Lists containing this project

README

        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 *

        TWILIO_API_KEY = get_secret('TWILIO_API_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-ipython_secrets

.. |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/