Skip to content

Commit

Permalink
Merge pull request #143 from CAM-Gerlach/update-funding-message
Browse files Browse the repository at this point in the history
PR: Update funding message, harmonize with main Spyder readme and minor fixes
  • Loading branch information
andfoy committed Jun 11, 2018
2 parents 6fcceb8 + 473612b commit c61b7dc
Showing 1 changed file with 88 additions and 56 deletions.
144 changes: 88 additions & 56 deletions README.rst
@@ -1,41 +1,30 @@
spyder-terminal
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.
|license| |pypi status| |pypi version| |conda version|
|circleci status| |appveyor status| |coverage| |backers| |gitter|

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| |pypi version| |gitter|


Build status
------------

|circleci status| |appveyor status| |coverage|


.. |appveyor status| image:: https://img.shields.io/appveyor/ci/spyder-ide/spyder-terminal/master.svg
.. |appveyor status| image:: https://ci.appveyor.com/api/projects/status/github/spyder-ide/spyder-terminal?branch=master&svg=true
:target: https://ci.appveyor.com/project/spyder-ide/spyder-terminal
:alt: Appveyor build status
.. |circleci status| image:: https://img.shields.io/circleci/project/github/spyder-ide/spyder-terminal/master.svg
:target: https://circleci.com/gh/spyder-ide/spyder-terminal/tree/master
:alt: Circle-CI build status
.. |license| image:: https://img.shields.io/pypi/l/spyder-terminal.svg
:target: LICENSE.txt
:alt: License
:alt: License (MIT)
.. |pypi status| image:: https://img.shields.io/pypi/status/spyder-terminal.svg
:target: https://github.com/spyder-ide/spyder-terminal
:alt: PyPI development status
.. |pypi version| image:: https://img.shields.io/pypi/v/spyder-terminal.svg
:target: https://pypi.python.org/pypi/spyder-terminal
:target: https://pypi.org/project/spyder-terminal
:alt: Latest PyPI version
.. |conda version| image:: https://img.shields.io/conda/vn/conda-forge/spyder-terminal.svg
:target: https://anaconda.org/conda-forge/spyder-terminal
:alt: Latest Conda-Forge version
.. |coverage| image:: https://coveralls.io/repos/github/spyder-ide/spyder-terminal/badge.svg
:target: https://coveralls.io/github/spyder-ide/spyder-terminal?branch=master
:alt: Code Coverage
:alt: Coveralls Code Coverage
.. |gitter| image:: https://badges.gitter.im/spyder-ide/spyder-terminal.svg
:target: https://gitter.im/spyder-ide/spyder-terminal
:alt: Join the chat at https://gitter.im/spyder-ide/spyder-terminal
Expand All @@ -46,29 +35,60 @@ Build status
:target: #sponsors
:alt: OpenCollective Sponsors

*Copyright © 2017–2018 Spyder Project Contributors*

Important Announcement: Spyder is unfunded!
-------------------------------------------
|linux-gif|

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.
.. |linux-gif| image:: https://github.com/spyder-ide/spyder-terminal/blob/master/doc/example.gif?raw=true
:alt: Animated GIF of Spyder-Terminal on Linux

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

https://opencollective.com/spyder
Plugin development paused until Spyder 4 release
------------------------------------------------

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.
Currently, work on official Spyder plugins is paused to focus our limited
resources on the development and release of Spyder 4, the next generation
of the Scientific Python Development Environment. Thanks to your continuing
support, we are on track for the final release of Spyder 4 in early 2019
with many highly anticipated features, including exposing a new public API for
external plugins, to make them easier to develop and more powerful.
Once that happens, active plugin development will resume, to add new features
and fix outstanding bugs. However, organizations or the community are welcome
to offer funding to continue development sooner; if so, please `contact us`_!

If you want to know more about this, please read this
`page`_.
Spyder development is made possible by contributions from our global user
community, along with organizations like `NumFOCUS`_ and `Quansight`_.
There are numerous `ways you can help`_, many of which don't require any
programming. If you'd like to make a `donation`_ to help fund further
improvements, we're on `OpenCollective`_.

Thanks for all you do to make the Spyder project thrive! `More details`_

.. _Anaconda, Inc: https://www.anaconda.com/
.. _page: https://github.com/spyder-ide/spyder/wiki/Anaconda-stopped-funding-Spyder
.. _contact us: mailto:ccordoba12@gmail.com
.. _NumFOCUS: https://www.numfocus.org
.. _Quansight: https://www.quansight.com
.. _ways you can help: https://github.com/spyder-ide/spyder/wiki/Contributing-to-Spyder
.. _donation: https://opencollective.com/spyder/donate
.. _OpenCollective: https://opencollective.com/spyder
.. _More details: https://github.com/spyder-ide/spyder/wiki/Current-Funding-and-Development-Status

----

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``.

|windows-gif|

.. |windows-gif| image:: https://github.com/spyder-ide/spyder-terminal/blob/master/doc/windows.gif?raw=true
:alt: Animated GIF of Spyder-Terminal on Windows


Installation
Expand All @@ -95,12 +115,12 @@ Dependencies

This project depends on

1. `Spyder <https://github.com/spyder-ide/spyder>`_
2. `Tornado <https://github.com/tornadoweb/tornado>`_
3. `Pexpect <https://github.com/pexpect/pexpect>`_ (*nix Systems)
4. `pywinpty <https://github.com/spyder-ide/pywinpty>`_ (Windows Systems)
4. `Coloredlogs <https://github.com/xolox/python-coloredlogs>`_
5. `xterm.js <https://github.com/sourcelair/xterm.js>`_
* `Spyder <https://github.com/spyder-ide/spyder>`_
* `Tornado <https://github.com/tornadoweb/tornado>`_
* `Pexpect <https://github.com/pexpect/pexpect>`_ (*nix Systems)
* `pywinpty <https://github.com/spyder-ide/pywinpty>`_ (Windows Systems)
* `Coloredlogs <https://github.com/xolox/python-coloredlogs>`_
* `xterm.js <https://github.com/sourcelair/xterm.js>`_

Changelog
Expand Down Expand Up @@ -139,18 +159,6 @@ 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-gif|

|windows-gif|

.. |linux-gif| image:: https://github.com/spyder-ide/spyder-terminal/blob/master/doc/example.gif?raw=true
:alt: Linux animated gif

.. |windows-gif| image:: https://github.com/spyder-ide/spyder-terminal/blob/master/doc/windows.gif?raw=true
:alt: Windows animated gif

~~~~~~~

Expand All @@ -168,3 +176,27 @@ Become a sponsor to get your logo on our README on Github.
.. image:: https://opencollective.com/spyder/sponsors.svg
:target: https://opencollective.com/spyder#support
:alt: Sponsors


More information
----------------

`Main Website <https://www.spyder-ide.org/>`_

`Download Spyder (with Anaconda) <https://www.anaconda.com/download/>`_

`Spyder Github <https://github.com/spyder-ide/spyder>`_

`Troubleshooting Guide and FAQ <https://github.com/spyder-ide/spyder/wiki/Troubleshooting-Guide-and-FAQ>`_

`Development Wiki <https://github.com/spyder-ide/spyder/wiki/Dev:-Index>`_

`Gitter Chatroom <https://gitter.im/spyder-ide/public>`_

`Google Group <https://groups.google.com/group/spyderlib>`_

`@Spyder_IDE on Twitter <https://twitter.com/spyder_ide>`_

`@SpyderIDE on Facebook <https://www.facebook.com/SpyderIDE/>`_

`Support Spyder on OpenCollective <https://opencollective.com/spyder/>`_

0 comments on commit c61b7dc

Please sign in to comment.