Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

54 lines (37 loc) · 1.24 KB
Raw

Contributing

Contributions to nbresuse are highly welcome!

Development set up

We recommend using pipenv to make development easier.

  1. Clone the git repository:

    git clone https://github.com/yuvipanda/nbresuse

  2. Create an environment that will hold our dependencies.

    cd nbresuse
pipenv --python 3.6

  3. Activate the virtual environment that pipenv created for us

    pipenv shell

  4. Do a dev install of nbresuse and its dependencies

    pip install --editable .

  5. Install and enable the nbextension for use with Jupyter Classic Notebook.

    jupyter nbextension install --py nbresuse --symlink --sys-prefix
jupyter serverextension enable --py nbresuse  --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix

  6. Start a Jupyter Notebook instance, open a new notebook and check out the memory usage in the top right!

    jupyter notebook

  7. If you want to test the memory limit display functionality, you can do so by setting the MEM_LIMIT environment variable (in bytes) when starting jupyter notebook.

    MEM_LIMIT=$(expr 128 \* 1024 \* 1024) jupyter notebook