Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/run-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ jobs:
run: pip install --no-deps -e spyder
- name: Install node.js
shell: bash -l {0}
run: conda install nodejs -y
run: conda install "nodejs >20" -y
- name: Install plugin dependencies (without Spyder)
if: matrix.SPYDER_SOURCE == 'git'
shell: bash -l {0}
Expand Down
43 changes: 13 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1,41 @@
# Spyder notebook plugin

This is a Spyder plugin to use Jupyter notebooks inside Spyder.
Currently it supports basic functionality such as creating new notebooks, opening any notebook in your filesystem and saving notebooks at any location.

Spyder plugin to use Jupyter notebooks inside Spyder. Currently it supports
basic functionality such as creating new notebooks, opening any notebook in
your filesystem and saving notebooks at any location.

You can also use Spyder's file switcher to easily switch between notebooks
and open an IPython console connected to the kernel of a notebook to inspect
its variables in the Variable Explorer.
You can also use Spyder's file switcher to easily switch between notebooks and open an IPython console connected to the kernel of a notebook to inspect its variables in the Variable Explorer.

## Project details

![license](https://img.shields.io/pypi/l/spyder-notebook.svg)
[![conda version](https://img.shields.io/conda/v/spyder-ide/spyder-notebook.svg)](https://www.anaconda.com/download/)
[![conda version](https://img.shields.io/conda/vn/conda-forge/spyder.svg)](https://anaconda.org/conda-forge/spyder)
[![download count](https://img.shields.io/conda/d/spyder-ide/spyder-notebook.svg)](https://www.anaconda.com/download/)
[![pypi version](https://img.shields.io/pypi/v/spyder-notebook.svg)](https://pypi.python.org/pypi/spyder-notebook)
[![Join the chat at https://gitter.im/spyder-ide/public](https://badges.gitter.im/spyder-ide/spyder.svg)](https://gitter.im/spyder-ide/public)
[![OpenCollective Backers](https://opencollective.com/spyder/backers/badge.svg?color=blue)](#backers)
[![OpenCollective Sponsors](https://opencollective.com/spyder/sponsors/badge.svg?color=blue)](#sponsors)

## Build status

[![Windows status](https://github.com/spyder-ide/spyder-notebook/workflows/Windows%20tests/badge.svg)](https://github.com/spyder-ide/spyder-notebook/actions?query=workflow%3A%22Windows+tests%22)
[![Linux status](https://github.com/spyder-ide/spyder-notebook/workflows/Linux%20tests/badge.svg)](https://github.com/spyder-ide/spyder-notebook/actions?query=workflow%3A%22Linux+tests%22)
[![MacOS status](https://github.com/spyder-ide/spyder-notebook/workflows/Macos%20tests/badge.svg)](https://github.com/spyder-ide/spyder-notebook/actions?query=workflow%3A%22Macos+tests%22)
[![OpenCollective Sponsors](https://opencollective.com/spyder/sponsors/badge.svg?color=blue)](#sponsors) <br>
[![Tests](https://github.com/spyder-ide/spyder-notebook/actions/workflows/run-tests.yml/badge.svg)](https://github.com/spyder-ide/spyder/actions/workflows/run-tests.yml)
[![codecov](https://codecov.io/gh/spyder-ide/spyder-notebook/branch/master/graph/badge.svg)](https://codecov.io/gh/spyder-ide/spyder-notebook/branch/master)
[![Crowdin](https://badges.crowdin.net/spyder-notebook/localized.svg)](https://crowdin.com/project/spyder-notebook)


## Installation

To install this plugin, you can use either ``pip`` or ``conda`` package managers, as follows:

Using conda (the recommended way!):
This plugin can be installed using the ``conda`` package manager as follows:

```
conda install spyder-notebook -c conda-forge
```

Using pip:
The plugin is also available on PyPI. In principle, you can use `pip` to install it, but this often leads to installations that do not work properly.

```
pip install spyder-notebook
```

**Note**: At the moment it is not possible to use this plugin with the [Spyder installers](http://docs.spyder-ide.org/current/installation.html#standalone-installers) for Windows and macOS. We're working to make that a reality in the future.
**Note**: At the moment it is not possible to use this plugin with [Spyder's stand-alone installers](http://docs.spyder-ide.org/current/installation.html#standalone-installers). We're working to make that a reality in the future.

## Dependencies

This project depends on:

* [Spyder](https://github.com/spyder-ide/spyder) (version 5.x)
* [Notebook](https://github.com/jupyter/notebook) (version 4.3 or later)

* [Spyder](https://github.com/spyder-ide/spyder)
* [Notebook](https://github.com/jupyter/notebook) from Jupyter

## Changelog
Visit our [CHANGELOG](CHANGELOG.md) file to know more about our new features and improvements.
Expand All @@ -70,13 +53,13 @@ You can ask your questions at the [Spyder group](https://groups.google.com/forum
or create a issue in this repo. We will be more than glad to answer.

## Overview
![example](https://raw.githubusercontent.com/spyder-ide/spyder-notebook/master/doc/example.gif)
![Screen shot](https://raw.githubusercontent.com/spyder-ide/spyder-notebook/master/doc/screenshot.png)

## Sponsors

Spyder and its subprojects are funded thanks to the generous support of

[![Quansight](https://static.wixstatic.com/media/095d2c_2508c560e87d436ea00357abc404cf1d~mv2.png/v1/crop/x_0,y_9,w_915,h_329/fill/w_380,h_128,al_c,usm_0.66_1.00_0.01/095d2c_2508c560e87d436ea00357abc404cf1d~mv2.png)](https://www.quansight.com/)[![Numfocus](https://i2.wp.com/numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png?fit=320%2C148&ssl=1)](https://numfocus.org/)
[![Chan Zuckerberg Initiative](https://raw.githubusercontent.com/spyder-ide/spyder/master/img_src/czi.png)](https://chanzuckerberg.com/)[![Numfocus](https://i2.wp.com/numfocus.org/wp-content/uploads/2017/07/NumFocus_LRG.png?fit=320%2C148&ssl=1)](https://numfocus.org/)

and the donations we have received from our users around the world through [Open Collective](https://opencollective.com/spyder/):

Expand Down
Binary file removed doc/example.gif
Binary file not shown.
Binary file added doc/screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading