Skip to content

Commit

Permalink
Merge branch 'main' into save_as_improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
krassowski authored Oct 3, 2024
2 parents c3530a5 + 9ae4cb1 commit a3ab817
Show file tree
Hide file tree
Showing 21 changed files with 144 additions and 56 deletions.
10 changes: 5 additions & 5 deletions .github/workflows/check-release.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Check Release
on:
push:
branches: ["master"]
branches: ["main"]
pull_request:
branches: ["*"]

Expand All @@ -14,9 +14,9 @@ jobs:
fail-fast: false
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v2
uses: actions/setup-python@v5
with:
python-version: 3.9
architecture: "x64"
Expand All @@ -25,7 +25,7 @@ jobs:
run: |
echo "::set-output name=dir::$(pip cache dir)"
- name: Cache pip
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ hashFiles('setup.cfg') }}
Expand All @@ -34,7 +34,7 @@ jobs:
${{ runner.os }}-pip-
- name: Cache checked links
if: ${{ matrix.group == 'link_check' }}
uses: actions/cache@v2
uses: actions/cache@v4
with:
path: ~/.cache/pytest-link-check
key: ${{ runner.os }}-linkcheck-${{ hashFiles('**/*.md', '**/*.rst') }}-md-links
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,12 @@ jobs:
fail-fast: false
matrix:
os: [ubuntu-22.04]
python-version: [ '3.7' ]
python-version: [ '3.10' ]
steps:
- name: Checkout
uses: actions/checkout@v1
uses: actions/checkout@v4
- name: Install Python ${{ matrix.python-version }}
uses: actions/setup-python@v1
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}
architecture: 'x64'
Expand All @@ -28,7 +28,7 @@ jobs:
run: |
echo "::set-output name=dir::$(pip cache dir)"
- name: Cache pip
uses: actions/cache@v1
uses: actions/cache@v4
with:
path: ${{ steps.pip-cache.outputs.dir }}
key: ${{ runner.os }}-pip-${{ matrix.python-version }}-${{ hashFiles('setup.py') }}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/downstream.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ jobs:

steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/js.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,18 @@ jobs:
- group: services
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Set up Node
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: '12.x'

- name: Cache node modules
uses: actions/cache@v2
uses: actions/cache@v4
env:
cache-name: cache-node-modules
with:
Expand All @@ -42,7 +42,7 @@ jobs:
${{ runner.os }}-
- name: Cache pip on Linux
uses: actions/cache@v1
uses: actions/cache@v4
if: startsWith(runner.os, 'Linux')
with:
path: ~/.cache/pip
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/playwright.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ jobs:
python-version: [ '3.7', '3.8', '3.9', '3.10']
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: ${{ matrix.python-version }}

- name: Set up Node
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: '12.x'

Expand Down
19 changes: 12 additions & 7 deletions .github/workflows/pythonpackage.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Testing nbclassic
on:
push:
branches:
- master
- main
pull_request:

jobs:
Expand All @@ -14,9 +14,14 @@ jobs:
matrix:
os: [ubuntu-22.04, macos-12, windows-2022]
python-version: ["3.7", "3.8", "3.9", "3.10"]
exclude:
- os: ubuntu-22.04
python-version: "3.7"
- os: macos-12
python-version: "3.7"
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Install pip dependencies
Expand Down Expand Up @@ -48,7 +53,7 @@ jobs:
# timeout-minutes: 20
# runs-on: ubuntu-latest
# steps:
# - uses: actions/checkout@v2
# - uses: actions/checkout@v4
# - name: Base Setup
# uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
# with:
Expand All @@ -64,7 +69,7 @@ jobs:
timeout-minutes: 20
steps:
- name: Checkout
uses: actions/checkout@v2
uses: actions/checkout@v4
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Install the Python dependencies
Expand All @@ -83,14 +88,14 @@ jobs:
runs-on: ubuntu-latest
timeout-minutes: 20
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Build SDist
run: |
pip install build
python -m build --sdist
- uses: actions/upload-artifact@v2
- uses: actions/upload-artifact@v4
with:
name: "sdist"
path: dist/*.tar.gz
Expand All @@ -104,7 +109,7 @@ jobs:
- name: Base Setup
uses: jupyterlab/maintainer-tools/.github/actions/base-setup@v1
- name: Download sdist
uses: actions/download-artifact@v2
uses: actions/download-artifact@v4
- name: Install From SDist
run: |
set -ex
Expand Down
35 changes: 33 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,39 @@

<!-- <START NEW CHANGELOG ENTRY> -->

## 1.1.0

([Full Changelog](https://github.com/jupyter/nbclassic/compare/v1.0.0...991361437fe0e51da639775f5fbe709cc8212278))

### Enhancements made

- Add issue templates to repository [#258](https://github.com/jupyter/nbclassic/pull/258) ([@RRosio](https://github.com/RRosio))

### Bugs fixed

- Make terminals_available false if key is not in settings dict yet [#261](https://github.com/jupyter/nbclassic/pull/261) ([@RRosio](https://github.com/RRosio))

### Maintenance and upkeep improvements

- fix: trust new notebooks and notebooks with new cells [#275](https://github.com/jupyter/nbclassic/pull/275) ([@maartenbreddels](https://github.com/maartenbreddels))
- Fix ci end-to-end tests [#274](https://github.com/jupyter/nbclassic/pull/274) ([@maartenbreddels](https://github.com/maartenbreddels))
- Fix `Linux JS Test` CI job [#269](https://github.com/jupyter/nbclassic/pull/269) ([@krassowski](https://github.com/krassowski))
- Update dependency requirements to minimum necessary [#259](https://github.com/jupyter/nbclassic/pull/259) ([@RRosio](https://github.com/RRosio))

### Documentation improvements

- Adding pydata_sphinx_theme to environment.yml file for docs build [#262](https://github.com/jupyter/nbclassic/pull/262) ([@RRosio](https://github.com/RRosio))
- Fix links for check_release links CI job [#260](https://github.com/jupyter/nbclassic/pull/260) ([@RRosio](https://github.com/RRosio))
- Port to PyData-Sphinx Theme [#256](https://github.com/jupyter/nbclassic/pull/256) ([@RRosio](https://github.com/RRosio))

### Contributors to this release

([GitHub contributors page for this release](https://github.com/jupyter/nbclassic/graphs/contributors?from=2023-05-04&to=2024-05-24&type=c))

[@jph00](https://github.com/search?q=repo%3Ajupyter%2Fnbclassic+involves%3Ajph00+updated%3A2023-05-04..2024-05-24&type=Issues) | [@krassowski](https://github.com/search?q=repo%3Ajupyter%2Fnbclassic+involves%3Akrassowski+updated%3A2023-05-04..2024-05-24&type=Issues) | [@maartenbreddels](https://github.com/search?q=repo%3Ajupyter%2Fnbclassic+involves%3Amaartenbreddels+updated%3A2023-05-04..2024-05-24&type=Issues) | [@RRosio](https://github.com/search?q=repo%3Ajupyter%2Fnbclassic+involves%3ARRosio+updated%3A2023-05-04..2024-05-24&type=Issues)

<!-- <END NEW CHANGELOG ENTRY> -->

## 1.0.0

([Full Changelog](https://github.com/jupyter/nbclassic/compare/v0.5.6...109a62153a74bae9a38f0c4bec460a91429f0c19))
Expand All @@ -20,8 +53,6 @@

[@echarles](https://github.com/search?q=repo%3Ajupyter%2Fnbclassic+involves%3Aecharles+updated%3A2023-04-27..2023-05-04&type=Issues)

<!-- <END NEW CHANGELOG ENTRY> -->

## 0.5.6

([Full Changelog](https://github.com/jupyter/nbclassic/compare/v0.5.5...ddbbf579a904ef1c040f3221f7dd64d287323636))
Expand Down
3 changes: 2 additions & 1 deletion docs/environment.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
name: nbclassic_docs
channels:
- conda-forge
- nodefaults
dependencies:
- python=3.8
- python=3.10
- pydata-sphinx-theme
- jinja2
- tornado
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
"\n",
"> Of course, in addition to the files listed, there are number of other files one needs to build a proper package. Here are some good resources:\n",
"- [The Hitchhiker's Guide to Packaging](https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/quickstart.html)\n",
"- [Repository Structure and Python](https://kenreitz.org/essays/2013/01/27/repository-structure-and-python) by Kenneth Reitz\n",
"- [Repository Structure and Python](https://kennethreitz.org/essays/2013/repository_structure_and_python) by Kenneth Reitz\n",
"\n",
"> How you distribute them, too, is important:\n",
"- [Packaging and Distributing Projects](https://python-packaging-user-guide.readthedocs.io/tutorials/distributing-packages/)\n",
Expand Down
16 changes: 16 additions & 0 deletions docs/source/nbclassic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,19 @@ if available at the `Jupyterlab-contrib website <https://jupyterlab-contrib.gith

.. _JEP #79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

Known issues
------------

Bellow are some known bugs and issues with the NbClassic project. These are items that may be of particular interest to users
migrating from notebook to nbclassic.

1. `#140 Error using jupyter_nbextensions_configurator with nbclassic <https://github.com/jupyter/nbclassic/issues/140>`_ is a
known issue with partial fix `Support nbclassic while updating the static path <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator/pull/141>`_
pending to be merged into the `Jupyter-contrib/jupyter_nbextensions_configurator <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator>`_ repository.

Once a release with this fix is available, users will be able to activate the extension with the following commands::

$ pip install 'jupyter_nbextensions_configurator @ git+https://github.com/datalayer-externals/jupyter-notebook-configurator.git@fix/nbclassic#egg=jupyter_nbextensions_configurator'
$ jupyter nbclassic-extension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
$ jupyter nbclassic-extension enable --sys-prefix --py jupyter_nbextensions_configurator
$ jupyter nbclassic-serverextension enable --sys-prefix --py jupyter_nbextensions_configurator
17 changes: 0 additions & 17 deletions docs/source/nbclassic_dev_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,3 @@ NbClassic Developer FAQ
.. _`allowed organization list`: https://github.com/MeeseeksBox/MeeseeksDev/blob/master/meeseeksdev/__init__.py#L26
.. _`Jupyter Community`: https://jupyter.org/community


Known issues
------------

Bellow are some known bugs and issues with the NbClassic project. These are items that may be of particular interest to users
migrating from notebook to nbclassic.

1. `#140 Error using jupyter_nbextensions_configurator with nbclassic <https://github.com/jupyter/nbclassic/issues/140>`_ is a
known issue with partial fix `Support nbclassic while updating the static path <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator/pull/141>`_
pending to be merged into the `Jupyter-contrib/jupyter_nbextensions_configurator <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator>`_ repository.

Once a release with this fix is available, users will be able to activate the extension with the following commands::

$ pip install 'jupyter_nbextensions_configurator @ git+https://github.com/datalayer-externals/jupyter-notebook-configurator.git@fix/nbclassic#egg=jupyter_nbextensions_configurator'
$ jupyter nbclassic-extension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
$ jupyter nbclassic-extension enable --sys-prefix --py jupyter_nbextensions_configurator
$ jupyter nbclassic-serverextension enable --sys-prefix --py jupyter_nbextensions_configurator
2 changes: 1 addition & 1 deletion nbclassic/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
import re

# Version string must appear intact for tbump versioning
__version__ = '1.1.0.dev0'
__version__ = '1.2.0.dev0'

# Build up version_info tuple for backwards compatibility
pattern = r'(?P<major>\d+).(?P<minor>\d+).(?P<patch>\d+)(?P<rest>.*)'
Expand Down
3 changes: 2 additions & 1 deletion nbclassic/notebookapp.py
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,7 @@ def initialize_handlers(self):
handlers.extend(load_handlers('nbclassic.tree.handlers'))
handlers.extend(load_handlers('nbclassic.notebook.handlers'))
handlers.extend(load_handlers('nbclassic.edit.handlers'))
handlers.extend(load_handlers('nbclassic.view.handlers'))
self.handlers.extend(handlers)

# Wildcard routes
Expand Down Expand Up @@ -324,7 +325,7 @@ def initialize_handlers(self):
router.add_rules(core_rules)
router.add_rules(static_handlers)
router.add_rules(final_rules)
print("""
print(r"""
_ _ _ _
| | | |_ __ __| |__ _| |_ ___
| |_| | '_ \/ _` / _` | _/ -_)
Expand Down
2 changes: 1 addition & 1 deletion nbclassic/static/base/js/namespace.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ define(function(){
// tree
jglobal('SessionList','tree/js/sessionlist');

Jupyter.version = "1.1.0.dev0";
Jupyter.version = "1.1.0";
Jupyter._target = '_blank';

return Jupyter;
Expand Down
2 changes: 1 addition & 1 deletion nbclassic/static/notebook/js/clipboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ function paste(event) {
}
}
first_inserted.focus_cell();
event.preventDefault();
}
event.preventDefault();
}

function notebookOnlyEvent(callback) {
Expand Down
4 changes: 3 additions & 1 deletion nbclassic/tests/end_to_end/test_display_isolation.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@


from .utils import EDITOR_PAGE
import pytest
import sys


@pytest.mark.skipif(sys.version_info >= (3, 8), reason="Fails in Python 3.8+")
def test_display_isolation(notebook_frontend):
import_ln = "from IPython.core.display import HTML, SVG, display, display_svg"
notebook_frontend.edit_cell(index=0, content=import_ln)
Expand Down
1 change: 1 addition & 0 deletions nbclassic/view/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Tornado handlers for viewing HTML files."""
Loading

0 comments on commit a3ab817

Please sign in to comment.