twisted.python._release.Project(object) class documentation

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

A representation of a project that has a version.

Instance Variable directory A twisted.python.filepath.FilePath pointing to the base directory of a Twisted-style Python package. The package should contain a _version.py file and a topfiles directory that contains a README file.
Method __init__ Undocumented
Method __repr__ Undocumented
Method getVersion
Method updateVersion Replace the existing version numbers in _version.py and README files with the specified version.
Method updateREADME Replace the existing version numbers in the README file with the specified version.
directory =
A twisted.python.filepath.FilePath pointing to the base directory of a Twisted-style Python package. The package should contain a _version.py file and a topfiles directory that contains a README file.
def __init__(self, directory): (source)
Undocumented
def __repr__(self): (source)
Undocumented
def getVersion(self): (source)
ReturnsA Version specifying the version number of the project based on live python modules.
def updateVersion(self, version): (source)

Replace the existing version numbers in _version.py and README files with the specified version.

ParametersversionThe version to update to.
def updateREADME(self, version): (source)

Replace the existing version numbers in the README file with the specified version.

ParametersversionThe version to update to.
API Documentation for Twisted, generated by pydoctor at 2016-04-04 15:02:49.