boilercv_docs.models.paths

Paths.

Module Contents

Classes

Constants	Constants.
RootedPaths	Paths.

Functions

get_root

Look for project root directory starting from current working directory.

Data

const	Constants.
rooted_paths

API

class boilercv_docs.models.paths.Constants(

/,

**data: typing.Any,

)

Bases: pydantic.BaseModel

Constants.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

pyproject: pathlib.Path

‘Path(…)’

docs: pathlib.Path

‘Path(…)’

boilercv_docs.models.paths.const

‘Constants(…)’

Constants.

boilercv_docs.models.paths.get_root() → pathlib.Path

Look for project root directory starting from current working directory.

class boilercv_docs.models.paths.RootedPaths(

/,

**data: typing.Any,

)

Bases: pydantic.BaseModel

Paths.

Initialization

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

root: pathlib.Path

‘get_root(…)’

pyproject: pathlib.Path

None

docs: pathlib.Path

None

apidocs: pathlib.Path

None

notebooks: pathlib.Path

None

docs_data: pathlib.Path

None

test_data: pathlib.Path

None

pipeline_data: pathlib.Path

None

boilercv_docs.models.paths.rooted_paths

‘RootedPaths(…)’