API Documentation

buildkit.build_dist(path, third_party_eggs_path, python='python2.6', setuptools_version='setuptools-0.6c11-py2.6.egg')

buildkit.build_html_docs(name, path)

buildkit.copy_files_to(found, dst)

buildkit.copy_html_docs(docs_path, name, path, version)

buildkit.cp(src, dst)

Copy a file from src to dst

buildkit.egg_index_page(docs_path, template_path)

buildkit.get_pkg_info(name, path)

buildkit.handle_one(path, requirement, eggs_path, third_party_eggs_path, python='python2.6', setuptools_version='setuptools-0.6c11-py2.6.egg', test_requirement=None)

buildkit.main_index_page(docs_path, template_path, exclude=None)

buildkit.package_index_page(eggs_path, package_docs_path, template_path, pkg_info)

docs_path

the directory containing the docs for all the modules

dir

The destination directory for the partcilular package’s docs

pkg_info

Package Info

buildkit.prepare_sources(src, dst)

buildkit.pull(path)

XXX pexpect needed??

buildkit.remove_dist(path)

Remove the build and dist directories from the package whose package root is at path.

buildkit.run(cmd, surpress_stdout=False, surpress_stderr=False, cwd=None)

Execute a command given by the list of parts cmd in the directory cwd.

buildkit.scan_for_files(base_path, ext=None)

buildkit.status(path)

buildkit.test_dist(requirement, path, eggs_path, third_party_eggs_path, python='python2.6', test_requirement=None)

name

The name of the package (ie its requiement)

path

The path to the source dir NOT USED

source

The path conating the virtualenv file and setuptools egg

third_party_eggs_path

The path to other eggs

buildkit.update(path)