t.p._.DistributionBuilder(object) : class documentation

Part of twisted.python._release View Source View In Hierarchy

A builder of Twisted distributions.

This knows how to build tarballs for Twisted and all of its subprojects.

Method __init__ Create a distribution builder.
Method buildTwisted Build the main Twisted distribution in Twisted-<version>.tar.bz2.
Method buildCore Build a core distribution in TwistedCore-<version>.tar.bz2.
Method buildSubProject Build a subproject distribution in Twisted<Projectname>-<version>.tar.bz2.
Method _createBasicSubprojectTarball Helper method to create and fill a tarball with things common between subprojects and core.
def __init__(self, rootDirectory, outputDirectory, templatePath=None): (source)
Create a distribution builder.
ParametersrootDirectoryroot of a Twisted export which will populate subsequent tarballs. (type: FilePath.)
outputDirectoryThe directory in which to create the tarballs. (type: FilePath)
templatePathPath to the template file that is used for the howto documentation. (type: FilePath)
def buildTwisted(self, version): (source)
Build the main Twisted distribution in Twisted-<version>.tar.bz2.

bin/admin is excluded.

ParametersversionThe version of Twisted to build. (type: str)
ReturnsThe tarball file. (type: FilePath.)
def buildCore(self, version): (source)

Build a core distribution in TwistedCore-<version>.tar.bz2.

This is very similar to buildSubProject, but core tarballs and the input are laid out slightly differently.

  • scripts are in the top level of the bin directory.
  • code is included directly from the twisted directory, excluding subprojects.
  • all plugins except the subproject plugins are included.
ParametersversionThe version of Twisted to build. (type: str)
ReturnsThe tarball file. (type: FilePath.)
def buildSubProject(self, projectName, version): (source)
Build a subproject distribution in Twisted<Projectname>-<version>.tar.bz2.
ParametersprojectNameThe lowercase name of the subproject to build. (type: str)
versionThe version of Twisted to build. (type: str)
ReturnsThe tarball file. (type: FilePath.)
def _createBasicSubprojectTarball(self, projectName, version, outputFile): (source)
Helper method to create and fill a tarball with things common between subprojects and core.
ParametersprojectNameThe subproject's name. (type: str)
versionThe version of the release. (type: str)
outputFileThe location of the tar file to create. (type: FilePath)
API Documentation for Twisted, generated by pydoctor at 2014-09-17 19:15:55.