Skip to content

Commit

Permalink
Merge pull request #93 from kirbs-/dev
Browse files Browse the repository at this point in the history
Lab Extension Support
  • Loading branch information
kirbs- authored Dec 7, 2020
2 parents 408b0f9 + 29ad649 commit befc47a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 20 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,42 +6,42 @@ hide_code is a Jupyter notebook extension to selectively hide code, prompts and

![demo](/images/demo.gif)

## Installation
## Jupyter Notebook Installation
1. `pip install hide_code`
2. `jupyter nbextension install --py hide_code`
3. `jupyter nbextension enable --py hide_code`
4. `jupyter serverextension enable --py hide_code`

## Jupyter Lab Installation
1. `pip instal hide_code[lab]`
2. `jupyter lab build`

## Upgrading with nbextension
1. `pip install hide_code --upgrade`
2. `jupyter nbextension install --py hide_code`

Note: add `--sys-prefix` to `jupyter nbextension` to install into virtualenv or conda environment.

## New in 0.5.3, 0.5.5 and 0.5.6
## Changes in 0.6.0
#### Improvements
* Added experiemental Jupyter Lab support. See [Lab usage](https://github.com/kirbs-/hide_code/wiki/Lab%20Usage) for details and limitations.
* Added Binder demo [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/kirbs-/hide_code/master?filepath=demo.ipynb)
* Simplified extension installation. No longer need to use nbextension/serverextension commands after pip install.
* No longer supporting Python 2.7 or . Install hide_code==0.5.2 for Python 2.7.
* 0.5.6 is the last version to support Python versions below 3.7.
* No longer supporting Python 2.7. Install hide_code==0.5.2 for Python 2.7.
* 0.5.6 is the last version to support Python 3.6 and older.
* Added extras_install [all] to install hide_code and all dependencies. Use `pip install hide_code[all]` to install. Resolves #85.

#### Bug Fixes
* Fixed latexpdf exporting.
* Changed nbconvert --to hide_code_pdf to use pdfkit.
* Fixed issue exporting notebooks after renaming a notebook.
* Resolved issue exporting notebooks with spaces in notebook name.
* Updated reading file to always use utf-8 encoding. This should resolve non-latin character issues.
* Renamed license file.



## Documentation
Visit the [Wiki](https://github.com/kirbs-/hide_code/wiki).

## Requirements
* Jupyter notebook ~>5.1
* Jupyter nbconvert ~>5.0.
* Jupyter notebook ~>6.1
* Jupyter nbconvert ~5.x
* pdfkit & [wkhtmltopdf](http://wkhtmltopdf.org/)
* Python 3.4+
* Python 3.7+

![hide_code-hits](https://caspersci.uk.to/cgi-bin/hits.cgi?q=hide_code&style=social&r=https://github.com/kirbs-/hide_code&l=https://caspersci.uk.to/images/tqdm.png&f=https://raw.githubusercontent.com/tqdm/tqdm/master/images/logo.gif)

![hide_code-hits](https://caspersci.uk.to/cgi-bin/hits.cgi?q=hide_code&style=social&r=https://github.com/kirbs-/hide_code&l=https://caspersci.uk.to/images/tqdm.png&f=https://raw.githubusercontent.com/tqdm/tqdm/master/images/logo.gif)
15 changes: 10 additions & 5 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ def run(self):
# Versions should comply with PEP440. For a discussion on single-sourcing
# the version across setup.py and the project code, see
# https://packaging.python.org/en/latest/single_source_version.html
version='0.5.6',
version='0.6.0',

description='A Jupyter notebook extension to hide code, prompts and outputs.',
long_description=long_description,
Expand Down Expand Up @@ -64,7 +64,6 @@ def run(self):

# Specify the Python versions you support here. In particular, ensure
# that you indicate whether you support Python 2, Python 3 or both.
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3.6',
'Programming Language :: Python :: 3.7',
'Programming Language :: Python :: 3.8',
Expand All @@ -85,9 +84,15 @@ def run(self):
install_requires=[
'jupyter',
'pdfkit',
'nbconvert>=5.0,<6',
'notebook>=5.1',
'traitlets<5'],
'nbconvert<6',
'notebook>=6.0',
'traitlets<5.0'
],

extras_require={
'all': ['notebook', 'hide_code_lab'],
'lab': ['hide_code_lab', 'jupyterlab~=2.0'],
},

# If there are data files included in your packages that need to be
# installed, specify them here. If using Python 2.6 or less, then these
Expand Down

0 comments on commit befc47a

Please sign in to comment.