Skip to content

zhj149/spyder-terminal

 
 

Repository files navigation

spyder-terminal

Spyder Plugin for displaying a virtual terminal (OS independent) inside the main Spyder window. Currently it supports both Unix-like and Windows operating systems.

This plugin allows you to execute flawlessly any bash command inside Spyder, even ncurses applications like nano or vi, or Windows console applications such as powershell.

Project information

License Latest PyPI version Join the chat at https://gitter.im/spyder-ide/spyder-terminal

Build status

Circle-CI build status Appveyor build status Code Coverage

Important Announcement: Spyder is unfunded!

Since mid November/2017, Anaconda, Inc has stopped funding Spyder development, after doing it for the past 18 months. Because of that, development will focus from now on maintaining Spyder 3 at a much slower pace than before.

If you want to contribute to maintain Spyder, please consider donating at

https://opencollective.com/spyder

We appreciate all the help you can provide us and can't thank you enough for supporting the work of Spyder devs and Spyder development.

If you want to know more about this, please read this page.

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

Dependencies

This project depends on

  1. Spyder
  2. Tornado
  3. Pexpect (*nix Systems)
  4. pywinpty (Windows Systems)
  5. Coloredlogs
  6. xterm.js

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>

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.

Overview

Linux animated gif

Windows animated gif


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

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 86.6%
  • JavaScript 7.0%
  • CSS 4.6%
  • HTML 1.8%