Go to the latest version of this document.
search in docstrings

Search bar offers the following options:

- Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: `+foo bar -baz`
- Wildcards. The below example searches for documents with words beginning with “foo”: `foo*`
- Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: `+qname:twisted.mail.* +search`

  Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.

- Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: `foo~1`

Results provided by Lunr.js

# ``twisted`.`python`.`_release`.`Project``

class documentation

`class Project: (source)`

Constructor: `Project(directory)`

View In Hierarchy

A representation of a project that has a version.

Method | `__init__` | Undocumented
Method | `__repr__` | Undocumented
Method | `getVersion` | No summary
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 `newsfragments` directory that contains a `README` file.

def __init__(self, directory): (source)

Undocumented

def __repr__(self) -> `str`: (source)

Undocumented

def getVersion(self): (source)

Returns
A `incremental.Version` specifying the version number of the project based on live python modules.

directory = (source)

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 `newsfragments` directory that contains a `README` file.