ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Shell​VE

by pykong ST3 Linux

Automagically opens a shell with a project's virtual environment already started.

Labels terminal, python, Virtualenv

Details

Installs

  • Total 178
  • Win 0
  • Mac 0
  • Linux 178
Apr 25 Apr 24 Apr 23 Apr 22 Apr 21 Apr 20 Apr 19 Apr 18 Apr 17 Apr 16 Apr 15 Apr 14 Apr 13 Apr 12 Apr 11 Apr 10 Apr 9 Apr 8 Apr 7 Apr 6 Apr 5 Apr 4 Apr 3 Apr 2 Apr 1 Mar 31 Mar 30 Mar 29 Mar 28 Mar 27 Mar 26 Mar 25 Mar 24 Mar 23 Mar 22 Mar 21 Mar 20 Mar 19 Mar 18 Mar 17 Mar 16 Mar 15 Mar 14 Mar 13 Mar 12
Windows 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Mac 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
Linux 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0

Readme

Source
raw.​githubusercontent.​com

ShellVE

Sublime Text 3 plugin to automagically open TerminalView tab with a project's virtual environment already started.

Why?

I always liked how PyCharm linked a project with a perticular virtual environment. You, easily set it up once. Then you never need to remember the correct virtual environment to start in you shell. One project, one virtual environment. And you project automatically runs with the correct one. The Virtualenv plugin for Sublime Text makes a similar linkage possible, but it is only for build systems. If you need more control, e.g. when wanting to install libs to your VE, you are going to need a shell. ShellVE fills that gap for you.

Installation

Do it via PackageControl. You likely know how to. (Else see PackageControl Usage.)

Satisfy dependencies

As the plugin relies on TerminalView as the terminal emulator and sole dependency. Hence you need to install TerminalView before you can use ShellVE.

Usage

1. Make sure virtual environment path is included into your .sublime-project:

[
          "settings": {
              "python_interpreter": "/home/user/.virtualenvs/example/bin/python"
          }
    ]

Note: This is the same format for specifying the VE path as used in the essential python development plugin Anaconda. Yet, the format is different from that used in the plugin Virtualenv.

2a. Just open the project and a view with a shell window with your virtual environment already started will automatically open.

How cool is that?
This is dependend on the sophisticated terminal plugin TerminalView by the ingenious Wramberg.

2b. Alternatively open via keybinding.

This is useful if you closed the automatically spawnded TerminalView.

Default keybindings:

Linux: ctrl + super + v

Limitations

  1. Currently works only on Linux. I am not going to expand it to other platforms, yet I will welcome any pull requests in this regard.

  2. Currently only works with TerminalView as the dependend terminal plugin. There are other great terminal emulators for Sublime Text, like Terminal or Glue. I am not going to expand it to other terminal plugins though either. Yet, also welcome regarding pull requests.

  3. Environment variables are not inherited from the virtual environment currently

TODO

  • Making sure terminal is always started in project folder.
  • Ensure environment variables are always the same, irrespective if a virtual environment is started in the system terminal or ShellVE.

Contributors

  • A big ThankYou to Wramberg for providing the amazing TerminalView plugin!