Boilerplate.py

(retrieved from 1.4.0 rc6 script directory)


 * 1) !/usr/bin/env python
 * 2) -*- coding: utf-8 -*-

import sys

try: # Please do not use 'from scribus import *'. If you must use a 'from import', # Do so _after_ the 'import scribus' and only import the names you need, such # as commonly used constants. import scribus except ImportError,err: print "This Python script is written for the Scribus scripting interface." print "It can only be run from within Scribus." sys.exit(1)


 * 1) YOUR IMPORTS GO HERE  #
 * 1) YOUR IMPORTS GO HERE  #

def main(argv): """This is a documentation string. Write a description of what your code   does here. You should generally put documentation strings ("docstrings")    on all your Python functions.""" #########################   #  YOUR CODE GOES HERE  # #########################   pass    # <--- Delete this line

def main_wrapper(argv): """The main_wrapper function disables redrawing, sets a sensible generic   status bar message, and optionally sets up the progress bar. It then runs    the main function. Once everything finishes it cleans up after the main    function, making sure everything is sane before the script terminates.""" try: scribus.statusMessage("Running script...") scribus.progressReset main(argv) finally: # Exit neatly even if the script terminated with an exception, # so we leave the progress bar and status bar blank and make sure # drawing is enabled. if scribus.haveDoc: scribus.setRedraw(True) scribus.statusMessage("") scribus.progressReset

if __name__ == '__main__': main_wrapper(sys.argv)
 * 1) This code detects if the script is being run as a script, or imported as a module.
 * 2) It only runs main if being run as a script. This permits you to import your script
 * 3) and control it manually for debugging.