project module#

Discover the JITX project and metadata.

Experimental

This package is experimental and may change.

exception NotAJitxProject(message, *, search_start, pyproject)[source]#

Bases: Exception

This does not appear to be a JITX project.

Parameters:

  • message (str)

  • search_start (str | Path)

  • pyproject (Path | None)

Return type:

None

class JitxProject(start='.')[source]#

Bases: PyProject

An object representing a JITX project and its metadata.

Parameters:

start (Path | str)

root: Path#
discover(start='.')[source]#

Determine the Jitx project given a path somewhere inside the project.

Raises an execption if no project is found.

Return type:

JitxProject

Parameters:

start (Path | str)