mirror of https://github.com/jupyter/notebook.git synced 2024-12-21 04:10:17 +08:00

Go to file

Min RK e5c8f4486f Merge pull request #572 from jakirkham/docker_build_fix Fixes the build on Docker Hub		2015-10-10 11:38:19 +02:00
docs	docs/source/changelog.rst: Note what we did.	2015-10-08 00:47:02 -04:00
git-hooks	Update githooks and description	2015-09-16 11:47:53 -07:00
notebook	Merge pull request #555 from ellisonbg/restartfix	2015-10-09 11:58:51 +02:00
scripts	scripts/lxc-launcher.sh: Remove the LXC launcher as it is now unused.	2015-10-08 00:47:02 -04:00
tools	start workign on typeahead	2015-08-10 17:35:45 -07:00
.bowerrc
.dockerignore	Adds a .dockerignore	2015-10-06 00:01:27 +02:00
.gitignore	Add generated notebooks rst files to version control	2015-09-24 15:16:38 -07:00
.gitmodules
.mailmap
.travis.yml	shrink travis matrix	2015-09-30 16:06:15 +02:00
bower.json	point bower at CodeMirror hash until a new version is released	2015-10-07 16:16:43 -04:00
CONTRIBUTING.md
COPYING.md
Dockerfile	Dockerfile: Turns out a copy of python is now packaged with this image. However, it blocks us from getting the development requirements that we want. As a result, we simply must purge this as our first step.	2015-10-09 18:57:36 -04:00
MANIFEST.in
package.json	Revert "Use NPM, node ES5, and browserify."	2015-08-27 09:00:15 +02:00
README.md	README.md: Appears that `-P` publishes to random ports so switch back to mapping ports explicitly. [ci skip]	2015-10-08 12:46:36 -04:00
setup.cfg
setup.py	formatting for long_description	2015-09-22 21:25:47 +02:00
setupbase.py	include typeahead with installation	2015-10-09 14:23:37 +02:00

README.md

Jupyter Notebook

The Jupyter HTML notebook is a web-based notebook environment for interactive computing.

Usage

Local installation

Launch with:

$ jupyter notebook

In a Docker container

If you have a Docker daemon running, e.g. reachable on localhost, start a container with:

$ docker run --rm -it -p 8888:8888 -v "$(pwd):/notebooks" jupyter/notebook

In your browser open the URL http://localhost:8888/. All notebooks from your session will be saved in the current directory.

On other platforms without docker, this can be started using docker-machine by replacing localhost with an IP from docker-machine ip <MACHINE>. With the deprecated boot2docker, this IP will be boot2docker ip.

Installation

For a local installation, make sure you have pip installed and run:

$ pip install notebook

Dev quickstart

ensure that you have node/npm installed (e.g. brew install node on OS X)
Clone this repo and cd into it
pip install --pre -e .

NOTE: For Debian/Ubuntu systems, if you're installing the system node you need to use the 'nodejs-legacy' package and not the 'node' package.

Ubuntu Trusty

sudo apt-get install nodejs-legacy npm python-virtualenv python-dev
# ensure setuptools/pip are up-to-date
pip install --upgrade setuptools pip
git clone https://github.com/jupyter/notebook.git
cd notebook
pip install --pre -e .
jupyter notebook

FreeBSD

cd /usr/ports/www/npm
sudo make install    # (Be sure to select the "NODE" option)
cd /usr/ports/devel/py-pip
sudo make install
cd /usr/ports/devel/py-virtualenv
sudo make install
cd /usr/ports/shells/bash
sudo make install
mkdir -p ~/.virtualenvs
python2.7 -m virtualenv ~/.virtualenvs/notebook
bash
source ~/.virtualenvs/notebook/bin/activate
pip install --upgrade setuptools pip pycurl
git clone https://github.com/jupyter/notebook.git
cd notebook
pip install -r requirements.txt -e .
jupyter notebook