Copyright © 2017–2018 Spyder Project Contributors
Spyder plugin for displaying an OS independent virtual terminal inside the main Spyder window. Currently supports both Unix-like and Windows operating systems.
Spyder-Terminal allows you to easily execute any bash
command inside Spyder, even ncurses
programs like nano
or vi
; or, on Windows, console applications such as powershell
.
To install this plugin, you can use either pip
or conda
package managers, as it follows:
Using pip:
pip install spyder-terminal
Using conda:
conda install spyder-terminal -c spyder-ide
Please be sure of installing a node and yarn version:
- ::
conda install -c conda-forge nodejs yarn
This project depends on
Visit our CHANGELOG file to know more about our new features and improvements.
Besides a Qt console, spyder-terminal also provides a web-based terminal interface based on Tornado, which allows you to deploy and serve terminals from a Web/Javascript frontend. To deploy only the server, you can execute the following bash script:
cd spyder_terminal/server
# Shell option:
# On Unix systems this can be bash/tcsh/zsh or any Unix shell:
# bash: /usr/bin/env bash
# On Windows systems this might be cmd or powershell:
# cmd: %SystemRoot%\windows\system32\cmd.exe
# powershell: %SystemRoot%\system32\WindowsPowerShell\v1.0\powershell.exe
python main.py --port <PORT> --shell <Path to the terminal backend to execute>
Install all the dependencies given in our requirements file depending on your OS, a distribution of node and yarn. Then, use the following bash script to build the plugin from source code.
- ::
python setup.py build_static
In order to run our test suite, install the dependencies for tests and make sure spyder-terminal is already installed. Then, use pytest to run the server and client tests for the terminal.
- ::
pytest .
To start contributing to this project, you must have installed the yarn
package manager, then you can execute python setup.py install
to test your changes on Spyder. We follow PEP8 and PEP257 style guidelines.
Support us with a monthly donation and help us continue our activities.
Become a sponsor to get your logo on our README on Github.