Skip to content

Commit bf2d177

Browse files
Merge pull request #14 from SylvainCorlay/stripout
Stripout Jupyter notebook frontend code
2 parents d129f78 + f052a07 commit bf2d177

File tree

358 files changed

+1238
-37360
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

358 files changed

+1238
-37360
lines changed

.bowerrc

Lines changed: 0 additions & 3 deletions
This file was deleted.

.travis.yml

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -16,37 +16,15 @@ env:
1616
global:
1717
- PATH=$TRAVIS_BUILD_DIR/pandoc:$PATH
1818
matrix:
19-
- GROUP=js/notebook
2019
- GROUP=python
21-
- GROUP=js/base
22-
- GROUP=js/services
2320

2421
before_install:
2522
- pip install --upgrade pip
2623
- pip install --upgrade setuptools wheel nose coverage codecov
27-
- nvm install 6.9.2
28-
- nvm use 6.9.2
29-
- node --version
30-
- npm --version
31-
- npm upgrade -g npm
32-
- npm install
33-
- |
34-
if [[ $GROUP == js* ]]; then
35-
36-
fi
3724
- |
3825
if [[ $GROUP == docs ]]; then
3926
pip install -r docs/doc-requirements.txt
4027
fi
41-
- |
42-
if [[ $GROUP == selenium ]]; then
43-
pip install selenium
44-
# Install Webdriver backend for Firefox:
45-
wget https://github.com/mozilla/geckodriver/releases/download/v0.19.1/geckodriver-v0.19.1-linux64.tar.gz
46-
mkdir geckodriver
47-
tar -xzf geckodriver-v0.19.1-linux64.tar.gz -C geckodriver
48-
export PATH=$PATH:$PWD/geckodriver
49-
fi
5028
5129
install:
5230
- pip install --pre .[test]
@@ -56,7 +34,7 @@ install:
5634
script:
5735
- jupyter kernelspec list
5836
- |
59-
symlinks=$(find . -type l| grep -v './node_modules/' | grep -v './git-hooks')
37+
symlinks=$(find . -type l| grep -v './git-hooks')
6038
if [[ $(echo $symlinks) ]]; then
6139
echo "Repository contains symlinks which won't work on windows:"
6240
echo $symlinks
@@ -65,9 +43,7 @@ script:
6543
else
6644
true
6745
fi
68-
- 'if [[ $GROUP == js* ]]; then travis_retry python -m notebook.jstest ${GROUP:3}; fi'
69-
- 'if [[ $GROUP == python ]]; then nosetests -v --exclude-dir notebook/tests/selenium --with-coverage --cover-package=notebook notebook; fi'
70-
- 'if [[ $GROUP == selenium ]]; then py.test -sv notebook/tests/selenium; fi'
46+
- 'if [[ $GROUP == python ]]; then nosetests -v --with-coverage --cover-package=jupyter_server jupyter_server; fi'
7147
- |
7248
if [[ $GROUP == docs ]]; then
7349
EXIT_STATUS=0
@@ -84,14 +60,6 @@ script:
8460
8561
matrix:
8662
include:
87-
- python: 3.6
88-
env:
89-
- GROUP=selenium
90-
- JUPYTER_TEST_BROWSER=firefox
91-
- MOZ_HEADLESS=1
92-
addons:
93-
firefox: 57.0
94-
9563
- python: 3.4
9664
env: GROUP=python
9765
- python: 3.5

CONTRIBUTING.rst

Lines changed: 18 additions & 112 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
Contributing to the Jupyter Notebook
2-
====================================
1+
Contributing to the Jupyter Server
2+
==================================
33

44
If you're reading this section, you're probably interested in contributing to
55
Jupyter. Welcome and thanks for your interest in contributing!
66

77
Please take a look at the Contributor documentation, familiarize yourself with
8-
using the Jupyter Notebook, and introduce yourself on the mailing list and
8+
using the Jupyter Server, and introduce yourself on the mailing list and
99
share what area of the project you are interested in working on.
1010

1111
General Guidelines
@@ -16,114 +16,43 @@ For general documentation about contributing to Jupyter projects, see the
1616

1717
__ https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html
1818

19-
2019
Setting Up a Development Environment
2120
------------------------------------
2221

23-
Installing Node.js and npm
24-
^^^^^^^^^^^^^^^^^^^^^^^^^^
25-
26-
Building the Notebook from its GitHub source code requires some tools to
27-
create and minify JavaScript components and the CSS,
28-
specifically Node.js and Node's package manager, ``npm``.
29-
It should be node version ≥ 6.0.
30-
31-
If you use ``conda``, you can get them with::
32-
33-
conda install -c conda-forge nodejs
34-
35-
If you use `Homebrew <https://brew.sh/>`_ on Mac OS X::
36-
37-
brew install node
38-
39-
Installation on Linux may vary, but be aware that the `nodejs` or `npm` packages
40-
included in the system package repository may be too old to work properly.
41-
42-
You can also use the installer from the `Node.js website <https://nodejs.org>`_.
43-
44-
45-
Installing the Jupyter Notebook
46-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
22+
Installing the Jupyter Server
23+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
4724

4825
Once you have installed the dependencies mentioned above, use the following
4926
steps::
5027

5128
pip install --upgrade setuptools pip
52-
git clone https://github.com/jupyter/notebook
53-
cd notebook
29+
git clone https://github.com/jupyter/jupyter_server
30+
cd jupyter_server
5431
pip install -e .
5532

56-
If you are using a system-wide Python installation and you only want to install the notebook for you,
33+
If you are using a system-wide Python installation and you only want to install the server for you,
5734
you can add ``--user`` to the install commands.
5835

59-
Once you have done this, you can launch the master branch of Jupyter notebook
36+
Once you have done this, you can launch the master branch of Jupyter server
6037
from any directory in your system with::
6138

62-
jupyter notebook
63-
64-
Verification
65-
^^^^^^^^^^^^
66-
67-
While running the notebook, select one of your notebook files (the file will have the extension ``.ipynb``).
68-
In the top tab you will click on "Help" and then click on "About". In the pop window you will see information about the version of Jupyter that you are running. You will see "The version of the notebook server is:".
69-
If you are working in development mode, you will see that your version of Jupyter notebook will include the word "dev".
70-
71-
.. image:: ./docs/source/_static/images/jupyter-verification.png
72-
:width: 40pt
73-
74-
If it does not include the word "dev", you are currently not working in development mode and should follow the steps below to uninstall and reinstall Jupyter.
39+
jupyter server
7540

7641
Troubleshooting the Installation
7742
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
7843

79-
If you do not see that your Jupyter Notebook is not running on dev mode, it's possible that you are
80-
running other instances of Jupyter Notebook. You can try the following steps:
44+
If you do not see that your Jupyter Server is not running on dev mode, it's possible that you are
45+
running other instances of Jupyter Server. You can try the following steps:
8146

82-
1. Uninstall all instances of the notebook package. These include any installations you made using
47+
1. Uninstall all instances of the jupyter_server package. These include any installations you made using
8348
pip or conda
84-
2. Run ``python3 -m pip install -e .`` in the notebook repository to install the notebook from there
49+
2. Run ``python3 -m pip install -e .`` in the jupyter_server repository to install the jupyter_server from there
8550
3. Run ``npm run build`` to make sure the Javascript and CSS are updated and compiled
86-
4. Launch with ``python3 -m notebook --port 8989``, and check that the browser is pointing to ``localhost:8989``
51+
4. Launch with ``python3 -m jupyter_server --port 8989``, and check that the browser is pointing to ``localhost:8989``
8752
(rather than the default 8888). You don't necessarily have to launch with port 8989, as long as you use
8853
a port that is neither the default nor in use, then it should be fine.
8954
5. Verify the installation with the steps in the previous section.
9055

91-
92-
Rebuilding JavaScript and CSS
93-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
94-
95-
There is a build step for the JavaScript and CSS in the notebook.
96-
To make sure that you are working with up-to-date code, you will need to run
97-
this command whenever there are changes to JavaScript or LESS sources::
98-
99-
npm run build
100-
101-
**IMPORTANT:** Don't forget to run ``npm run build`` after switching branches.
102-
When switching between branches of different versions (e.g. ``4.x`` and
103-
``master``), run ``pip install -e .``. If you have tried the above and still
104-
find that the notebook is not reflecting the current source code, try cleaning
105-
the repo with ``git clean -xfd`` and reinstalling with ``pip install -e .``.
106-
107-
Development Tip
108-
"""""""""""""""
109-
110-
When doing development, you can use this command to automatically rebuild
111-
JavaScript and LESS sources as they are modified::
112-
113-
npm run build:watch
114-
115-
Git Hooks
116-
"""""""""
117-
118-
If you want to automatically update dependencies and recompile JavaScript and
119-
CSS after checking out a new commit, you can install post-checkout and
120-
post-merge hooks which will do it for you::
121-
122-
git-hooks/install-hooks.sh
123-
124-
See ``git-hooks/README.md`` for more details.
125-
126-
12756
Running Tests
12857
-------------
12958

@@ -140,42 +69,19 @@ To run the Python tests, use::
14069

14170
If you want coverage statistics as well, you can run::
14271

143-
nosetests --with-coverage --cover-package=notebook notebook
144-
145-
JavaScript Tests
146-
^^^^^^^^^^^^^^^^
147-
148-
To run the JavaScript tests, you will need to have PhantomJS and CasperJS
149-
installed::
150-
151-
npm install -g casperjs phantomjs-prebuilt
152-
153-
Then, to run the JavaScript tests::
154-
155-
python -m notebook.jstest [group]
156-
157-
where ``[group]`` is an optional argument that is a path relative to
158-
``notebook/tests/``.
159-
For example, to run all tests in ``notebook/tests/notebook``::
160-
161-
python -m notebook.jstest notebook
162-
163-
or to run just ``notebook/tests/notebook/deletecell.js``::
164-
165-
python -m notebook.jstest notebook/deletecell.js
166-
72+
nosetests --with-coverage --cover-package=jupyter_server jupyter_server
16773

16874
Building the Documentation
16975
--------------------------
17076

17177
To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/>`_,
17278
`pandoc <http://pandoc.org/>`_ and a few other packages.
17379

174-
To install (and activate) a `conda environment`_ named ``notebook_docs``
80+
To install (and activate) a `conda environment`_ named ``server_docs``
17581
containing all the necessary packages (except pandoc), use::
17682

17783
conda env create -f docs/environment.yml
178-
source activate notebook_docs # Linux and OS X
84+
source activate server_docs # Linux and OS X
17985
activate notebook_docs # Windows
18086

18187
.. _conda environment:

MANIFEST.in

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
include COPYING.md
22
include CONTRIBUTING.rst
33
include README.md
4-
include package.json
5-
include bower.json
6-
include .bowerrc
74
include setupbase.py
85
include Dockerfile
96
graft tools

README.md

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,35 @@
1-
# Jupyter Notebook
1+
# Jupyter Server
22

33
[![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter)
4-
[![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook)
5-
[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.io/en/latest/?badge=latest)
6-
4+
[![Build Status](https://travis-ci.org/jupyter/jupyter-server.svg?branch=master)](https://travis-ci.org/jupyter/jupyter-server)
5+
[![Documentation Status](https://readthedocs.org/projects/jupyter-server/badge/?version=latest)](http://jupyter-server.readthedocs.io/en/latest/?badge=latest)
76

8-
9-
The Jupyter notebook is a web-based notebook environment for interactive
10-
computing.
11-
12-
![Jupyter notebook example](docs/resources/running_code_med.png "Jupyter notebook example")
13-
14-
### Jupyter notebook, the language-agnostic evolution of IPython notebook
15-
Jupyter notebook is a language-agnostic HTML notebook application for
16-
Project Jupyter. In 2015, Jupyter notebook was released as a part of
17-
The Big Split™ of the IPython codebase. IPython 3 was the last major monolithic
18-
release containing both language-agnostic code, such as the *IPython notebook*,
19-
and language specific code, such as the *IPython kernel for Python*. As
20-
computing spans across many languages, Project Jupyter will continue to develop the
21-
language-agnostic **Jupyter notebook** in this repo and with the help of the
22-
community develop language specific kernels which are found in their own
23-
discrete repos.
24-
[[The Big Split™ announcement](https://blog.jupyter.org/the-big-split-9d7b88a031a7)]
25-
[[Jupyter Ascending blog post](https://blog.jupyter.org/jupyter-ascending-1bf5b362d97e)]
7+
The Jupyter Server provides the backend for Jupyter web applications such as
8+
the Jupyter notebook and JupyterLab.
269

2710
## Installation
11+
2812
You can find the installation documentation for the
2913
[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html).
3014
The documentation for advanced usage of Jupyter notebook can be found
31-
[here](https://jupyter-notebook.readthedocs.io/en/latest/).
15+
[here](https://jupyter-server.readthedocs.io/en/latest/).
3216

3317
For a local installation, make sure you have
3418
[pip installed](https://pip.readthedocs.io/en/stable/installing/) and run:
3519

36-
$ pip install notebook
20+
$ pip install jupyter_server
3721

38-
## Usage - Running Jupyter notebook
22+
## Usage - Running Jupyter Server
3923

4024
### Running in a local installation
4125

4226
Launch with:
4327

44-
$ jupyter notebook
28+
$ jupyter server
4529

4630
### Running in a remote installation
4731

48-
You need some configuration before starting Jupyter notebook remotely. See [Running a notebook server](http://jupyter-notebook.readthedocs.io/en/stable/public_server.html).
32+
You need some configuration before starting Jupyter server remotely. See [Running a Jupyter server](http://jupyter-server.readthedocs.io/en/stable/public_server.html).
4933

5034
## Development Installation
5135

@@ -58,8 +42,8 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C
5842
## Resources
5943
- [Project Jupyter website](https://jupyter.org)
6044
- [Online Demo at try.jupyter.org](https://try.jupyter.org)
61-
- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)]
45+
- [Documentation for Jupyter Server](https://jupyter-server.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-server/latest/jupyter-server.pdf)]
6246
- [Korean Version of Installation](https://github.com/ChungJooHo/Jupyter_Kor_doc/)
6347
- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)]
64-
- [Issues](https://github.com/jupyter/notebook/issues)
48+
- [Issues](https://github.com/jupyter/jupyter-server/issues)
6549
- [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter)

appveyor.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ install:
1919
- cmd: conda config --set show_channel_urls true
2020
- cmd: conda config --add channels conda-forge
2121
#- cmd: conda update --yes --quiet conda
22-
- cmd: conda install -y pyzmq tornado jupyter_client nbformat nbconvert ipykernel pip nodejs nose
22+
- cmd: conda install -y pyzmq tornado jupyter_client nbformat nbconvert ipykernel pip nose
2323
- cmd: pip install .[test]
2424

2525
test_script:
26-
- nosetests -v notebook --exclude-dir notebook\tests\selenium
26+
- nosetests -v jupyter_server --exclude-dir notebook\tests\selenium

bower.json

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)