twisted.python._release.DistributionBuilder : API documentation

A builder of Twisted distributions.

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

Class Variables blacklist The list of subproject names to exclude from the main Twisted tarball and for which no individual project tarballs will be built. The same list as PROJECT_BLACKLIST. (type: list of str )

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	_buildDocInDir	Generate documentation in the given path, building man pages first if necessary and swallowing errors (so that directories without lore documentation in them are ignored).
Method	_createBasicSubprojectTarball	Helper method to create and fill a tarball with things common between subprojects and core.

def __init__(self, rootDirectory, outputDirectory, apiBaseURL=None): (source)

Create a distribution builder.

Parameters	rootDirectory	root of a Twisted export which will populate subsequent tarballs. (type: `FilePath`. )
	outputDirectory	The directory in which to create the tarballs. (type: `FilePath` )
	apiBaseURL	A format string which will be interpolated with the fully-qualified Python name for each API link. For example, to generate the Twisted 8.0.0 documentation, pass `"http://twistedmatrix.com/documents/8.0.0/api/%s.html"`. (type: `str` or `NoneType` )

def _buildDocInDir(self, path, version, howtoPath): (source)

Generate documentation in the given path, building man pages first if necessary and swallowing errors (so that directories without lore documentation in them are ignored).

Parameters	path	The path containing documentation to build. (type: `FilePath` )
	version	The version of the project to include in all generated pages. (type: `str` )
	howtoPath	The "resource path" as `DocBuilder` describes it. (type: `FilePath` )

def buildTwisted(self, version): (source)

Build the main Twisted distribution in Twisted-<version>.tar.bz2.

Projects listed in in blacklist will not have their plugins, code, documentation, or bin directories included.

bin/admin is also excluded.

Parameters	version	The version of Twisted to build. (type: `str` )
Returns	The 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.

Parameters	version	The version of Twisted to build. (type: `str` )
Returns	The tarball file. (type: `FilePath`. )

def buildSubProject(self, projectName, version): (source)

Build a subproject distribution in Twisted<Projectname>-<version>.tar.bz2.

Parameters	projectName	The lowercase name of the subproject to build. (type: `str` )
	version	The version of Twisted to build. (type: `str` )
Returns	The 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.

Parameters	projectName	The subproject's name. (type: `str` )
	version	The version of the release. (type: `str` )
	outputFile	The location of the tar file to create. (type: `FilePath` )

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