xonsh.xontribs_meta

This modules is the place where one would define the xontribs.

class xonsh.xontribs_meta.Xontrib(url: str = '', description: Union[str, xonsh.lazyasd.LazyObject] = '', package: Optional[xonsh.xontribs_meta._XontribPkg] = None, tags: Tuple[str, ...] = ())

Meta class that is used to describe xontribs.

Attributes

url

url to the home page of the xontrib.

description

short description about the xontrib.

package

pkg information for installing the xontrib

tags

category.

Create new instance of Xontrib(url, description, package, tags)

count(value, /)

Return number of occurrences of value.

index(value, start=0, stop=sys.maxsize, /)

Return first index of value.

Raises ValueError if the value is not present.

description: Union[str, xonsh.lazyasd.LazyObject]

Alias for field number 1

package: Optional[xonsh.xontribs_meta._XontribPkg]

Alias for field number 2

tags: Tuple[str, ...]

Alias for field number 3

url: str

Alias for field number 0

xonsh.xontribs_meta.get_installed_xontribs(pkg_name='xontrib')

List all core packages + newly installed xontribs

xonsh.xontribs_meta.get_module_docstring(module: str) → str

Find the module and return its docstring without actual import

xonsh.xontribs_meta.get_xontribs() → Dict[str, xonsh.xontribs_meta.Xontrib]

Return xontrib definitions lazily.