API

Package emcdproj

Project management utilities.

emcdproj.main()

Entrypoint.

Module emcdproj.website

Static website maintenance utilities for projects.

Module emcdproj.filesystem

Filesystem operations and utilities.

emcdproj.filesystem.chdir(directory)

Temporarily changes working directory.

Not thread-safe or async-safe.

Module emcdproj.interfaces

Abstract bases and interfaces.

class emcdproj.interfaces.CliCommand

Bases: DataclassProtocol, Protocol

CLI command.

class emcdproj.interfaces.ConsoleDisplay(*, silence: typing.Annotated[bool, _ArgConfig(name=None, metavar=None, help=None, help_behavior_hint=None, aliases=('--quiet', '--silent'), prefix_name=False, constructor_factory=None, default=tyro.MISSING_NONPROP)] = False, file: Annotated[Optional[pathlib.Path], _ArgConfig(name='console-capture-file', metavar=None, help=None, help_behavior_hint=None, aliases=None, prefix_name=False, constructor_factory=None, default=tyro.MISSING_NONPROP)] = None, stream: typing.Annotated[emcdproj.interfaces.DisplayStreams, _ArgConfig(name='console-stream', metavar=None, help=None, help_behavior_hint=None, aliases=None, prefix_name=False, constructor_factory=None, default=tyro.MISSING_NONPROP)] = <DisplayStreams.Stderr: 'stderr'>)

Bases: DataclassObject

Variables:

• silence (bool)

• file (pathlib.Path | None)

• stream (emcdproj.interfaces.DisplayStreams)

async provide_stream()

Provides output stream for display.

Parameters:

self

Return type:

_io.TextIOWrapper

class emcdproj.interfaces.DisplayStreams(value)

Bases: Enum

Stream upon which to place output.

Module emcdproj.exceptions

Family of exceptions for package API.

exception emcdproj.exceptions.DataAwol(source, label)

Bases: Omnierror, AssertionError

Unexpected data absence.

exception emcdproj.exceptions.FileAwol(file)

Bases: Omnierror, AssertionError

Unexpected file absence.

exception emcdproj.exceptions.FileDataAwol(file, label)

Bases: DataAwol

Unexpected data absence from file.

exception emcdproj.exceptions.FileEmpty(file)

Bases: Omnierror, AssertionError

Unexpectedly empty file.

exception emcdproj.exceptions.Omnierror(*posargs, **nomargs)

Bases: Omniexception, Exception

Base for error exceptions raised by package API.

exception emcdproj.exceptions.Omniexception(*posargs, **nomargs)

Bases: Omniexception

Base for all exceptions raised by package API.

exception emcdproj.exceptions.PublicationSourceInvalidity(source, issue)

Bases: Omnierror, ValueError

Invalid publication source or tree.

exception emcdproj.exceptions.TrackConfigurationInvalidity(track, issue)

Bases: Omnierror, ValueError

Invalid publication track configuration.