Sublime text 3 plugin for PyBuilder
Python JavaScript
Clone or download
mriehl Use pythonw instead of python on win32 platforms
Using pythonw avoids spawning a terminal window (which is useless)
when spawning commands.
Latest commit dbb0740 Mar 9, 2015

README.md

sublime_pybuilder

Sublime text 3 plugin for PyBuilder.

sublime_pybuilder provides PyBuilder integration for Sublime Text 3

Features

  • Real-time output
  • Minimal configuration if you use Anaconda or SublimePythonIDE as it reuses the settings
  • Does not block so you can work or check out what to do next while building.
  • pyb-init support built-in

Installation

Install it with package control.

Usage

Several commands will be made available to you through the command palette. You can use them to :

  • Run PyBuilder (implies default tasks)
  • Show the coverage of your project (using PyBuilder)
  • Clean your project
  • Run unit tests
  • Run integration tests
  • Analyze (lint, etc.) your project
  • Publish your project
  • Verify your project
  • Run pyb-init on your project

Mandatory configuration

sublime_pybuilder expects two project settings to be present:

  • python_interpreter This is the path to your python interpreter. Could be your system python or a virtualenv.
  • project_root The root of your project where the build descriptor (build.py) is located.

Here's what your project settings might look like :

{
    "folders":
    [
        {
            "follow_symlinks": true,
            "path": "/home/mriehl/workspace/yadtshell"
        }
    ],
    "settings":
    {
        "python_interpreter": "/home/mriehl/workspace/yadtshell/venv/bin/python",
        "project_root": "/home/mriehl/workspace/yadtshell",
        "extra_paths": ["home/mriehl/workspace/yadtshell/src/main/python"]
    }
}

I'm using Anaconda so I added the project sources with the extra_paths setting so that autocompletion and goto definition work. It is not necessary for sublime_pybuilder to work.

Special case - only if you want to work on the PyBuilder project itself!

In order to build pybuilder, you need to run a bootstrapping script. This script must be run with the right python interpreter in order to see your packages. Thus we need to specify the path to the bootstrapping script additionally with the setting pyb_path.

My settings are:

{
    "folders":
    [
        {
            "follow_symlinks": true,
            "path": "/home/mriehl/workspace/pybuilder"
        }
    ],
    "settings":
    {
        "python_interpreter": "/home/mriehl/workspace/pybuilder/venv/bin/python",
        "pyb_path": "/home/mriehl/workspace/pybuilder/bootstrap",
        "project_root": "/home/mriehl/workspace/pybuilder"
    }
}

Optional configuration

  • sublime_pybuilder_output_panel_color_scheme can be set to a color scheme you like (the default is "Packages/Color Scheme - Default/Monokai.tmTheme"). It will be used for the output panel.

License

MIT