Skip to main content

A Jupyter notebook extension to hide code.

Project description

Hide_code
=========

.. image:: https://img.shields.io/github/license/mashape/apistatus.svg

Release build

.. image:: https://travis-ci.org/kirbs-/hide_code.svg?branch=master

Development build

.. image:: https://travis-ci.org/kirbs-/hide_code.svg?branch=dev)

Introduction
============
hide_code is an extension for Jupyter/IPython notebooks to selectively hide code and prompts. Make a notebook a code free document for exporting or presenting with a single click by pressing

.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/button.png

Normal
------
.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/1.1.png
:scale: 50 %

Hide code enabled
-----------------
.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/1.2.png

Or customize each cell by selecting "Hide code" from the Cell Toolbar dropdown. Then use "Hide Code" and "Hide Prompts" checkboxes to hide the specific cell's code or cell's input/output prompts.

.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/2.png

Normal
------
.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/3.1.png

Hide code enabled
-----------------
.. image:: https://raw.githubusercontent.com/kirbs-/hide_code/dev/images/3.2.png

Installation
============
Via pip
-------
`pip install hide_code`

Via setuptools
--------------
1. Download and unzip this repository.
2. Change to unzipped directory.
3. Execute `python setup.py install`

Installation Troubleshooting
============================
If installation complains the directory doesn't exist, you're Jupyter/IPython installation probably isn't in one of the usual places. Locate Jupyter's configuration directory, then use code below to install in a non-standard directory.
`
import hide_code.hide_code as hc
dir = "<full path to Jupyter config directory>"
hc.install(dir)
`

Requirements
============
* Jupyter notebook 4+
* Python 2.7+ if installing with pip

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hide_code-0.1.5.tar.gz (6.2 kB view details)

Uploaded Source

File details

Details for the file hide_code-0.1.5.tar.gz.

File metadata

  • Download URL: hide_code-0.1.5.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for hide_code-0.1.5.tar.gz
Algorithm Hash digest
SHA256 de5cbe4e09096e18b1bb526777f6ddf321ec5fdd3e97f95aaaaaefe09f39e50c
MD5 592bc764cd1f807088836ead9835aca3
BLAKE2b-256 36486a2b5a1f0c9dbc9d2074bf48af74b11498f873f84cb55ebb53ff2ef4c1cf

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page