reuse.project module¶
Module that contains the central Project class.
-
class
reuse.project.
Project
(root: os.PathLike, include_submodules: bool = False)[source]¶ Bases:
object
Simple object that holds the project’s root, which is necessary for many interactions.
-
all_files
(directory: os.PathLike = None) → Iterator[pathlib.Path][source]¶ Yield all files in directory and its subdirectories.
The files that are not yielded are:
Files ignored by VCS (e.g., see .gitignore)
Files/directories matching IGNORE_*_PATTERNS.
-
property
root
¶ Path to the root of the project.
-