sview package

Submodules

sview.builder module

class sview.builder.Builder(logger=None, **config)

Bases: object

build()

Rebuilds a target in a specified working directory. If the target is a directory, then all contents of the directory will be copied into the working directory prior to building. This function also builds a simplistic conf.py for sphinx-build

build_api_doc()

build_conf_file()

copy_dir()

copy_file()

fetch_ext_from_index(include_dot=True)

remake_build_dir()

setup_venv()

sview.builder.activate_this(venv_dir)

This function activates a virtual environment for the currently running python interpreter. This funciton is essentially a copy of ‘activate_this.py’ from virtualenv, but since this application uses venv, this function had to be copied over. It has a few variations, but otherwise it has the same functionality

sview.builder.copy(src, dst)

This is a convenience function that copies a file or directory

sview.builder.rm(dst)

This is a convenience function that deletes a file or directory

sview.exceptions module

exception sview.exceptions.SviewError(message, *format_args, **format_kwds)

Bases: buzz.Buzz

sview.server module

sview.server.create_server(**config)

Creates a new flask app and wraps it in a livereload server. If the config calls for a package build, this funciton will also create and activate a virtual environment in the build directory so that autodoc can properly import needed modules