Skip to content

Cwickniss/spyder-terminal

 
 

Repository files navigation

Spyder-Terminal

License (MIT) PyPI development status Latest PyPI version Latest Conda-Forge version Circle-CI build status Appveyor build status Coveralls Code Coverage OpenCollective Backers Join the chat at https://gitter.im/spyder-ide/spyder-terminal

Copyright © 2017–2018 Spyder Project Contributors

Animated GIF of Spyder-Terminal on Linux


Overview

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.

Animated GIF of Spyder-Terminal on Windows

Installation

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

Dependencies

This project depends on

Changelog

Visit our CHANGELOG file to know more about our new features and improvements.

Server implementation

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>

Build from source code

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

Run tests

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 .

Development and contribution

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.

Backers

Sponsors

Become a sponsor to get your logo on our README on Github.

Sponsors

More information

Main Website

Download Spyder (with Anaconda)

Spyder Github

Troubleshooting Guide and FAQ

Development Wiki

Gitter Chatroom

Google Group

@Spyder_IDE on Twitter

@SpyderIDE on Facebook

Support Spyder on OpenCollective

About

Run system terminals inside Spyder. Works on Linux, macOS and Windows.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 82.3%
  • JavaScript 8.8%
  • CSS 4.2%
  • Shell 2.3%
  • Batchfile 1.5%
  • HTML 0.9%