Project
sereto.project
¶
Project
dataclass
¶
Source code in sereto/project.py
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | |
config_path
property
¶
Get the path to the project configuration file.
ensure_dir(relative_path)
¶
Ensure a directory inside the project exists, creating it if necessary.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
relative_path
|
str | Path
|
Path relative to the project root (e.g. "pdf" or "reports/html"). |
required |
Returns:
| Type | Description |
|---|---|
Path
|
Absolute Path to the ensured directory. |
Raises:
| Type | Description |
|---|---|
SeretoValueError
|
If the path is absolute or escapes the project root. |
SeretoPathError
|
If a non-directory object exists at the target path. |
Source code in sereto/project.py
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | |
reload()
¶
Re-read the project configuration (incl. targets and findings) from disk.
The configuration is cached on first access, so long-running consumers (e.g. the TUI) must call this to pick up changes made to the project files in the meantime. The new configuration is loaded completely before it replaces the cached one, so concurrent readers never observe a missing or partially loaded configuration.
Raises:
| Type | Description |
|---|---|
Exception
|
If loading fails. The previously cached configuration is kept intact. |
Source code in sereto/project.py
58 59 60 61 62 63 64 65 66 67 68 | |
get_project_path_from_dir(dir=None, dir_subtree=Path('/'))
¶
Get the path to the project directory.
Start the search from the 'dir' directory and go up the directory tree until the project directory is found or 'dir_subtree' is reached.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
dir
|
DirectoryPath | None
|
The directory to start the search from. Defaults to the current working directory. |
None
|
dir_subtree
|
DirectoryPath
|
The directory to stop the search at. Defaults to the root directory. |
Path('/')
|
Raises:
| Type | Description |
|---|---|
SeretoPathError
|
If the current working directory is not inside the project's (sub)directory. |
Returns:
| Type | Description |
|---|---|
Path
|
The path to the project directory. |
Source code in sereto/project.py
167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 | |
init_build_dir(project, version_config=None, target=None)
¶
Initialize the build directory.
Source code in sereto/project.py
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 | |
is_project_dir(path)
¶
Check if the provided path is a root directory of a project.
A project directory contains at least .sereto and config.json files.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path
|
Path
|
The path to examine. |
required |
Returns:
| Type | Description |
|---|---|
bool
|
True if the path is a project directory, False otherwise. |
Source code in sereto/project.py
117 118 119 120 121 122 123 124 125 126 127 128 129 | |
new_project(projects_path, templates_path, risk_due_dates, id, name, people)
¶
Generates a new project with the specified ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
projects_path
|
DirectoryPath
|
The path to the projects directory. |
required |
templates_path
|
DirectoryPath
|
The path to the templates directory. |
required |
risk_due_dates
|
dict[TargetExposure, dict[Risk, timedelta]]
|
due dates for fixing the findings, for each risk level and target exposure, as a timedelta |
required |
id
|
TypeProjectId
|
The ID of the new project. This should be a string that uniquely identifies the project. |
required |
name
|
str
|
The name of the new project. |
required |
people
|
list[Person]
|
Initial list of people from global settings. |
required |
Raises:
| Type | Description |
|---|---|
SeretoValueError
|
If a project with the specified ID already exists in the |
Source code in sereto/project.py
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 | |
project_create_missing(project, version_config)
¶
Creates missing content in the project.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
project
|
Project
|
The project instance. |
required |
version_config
|
VersionConfig
|
Configuration for a specific project version. |
required |
Source code in sereto/project.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 | |
resolve_project_directory(projects_path, project_id, *, templates_path)
¶
Resolve a project identifier to an on-disk path.
First match wins: if a directory with the exact name of project_id exists, it is returned.
Otherwise, all project directories are scanned and their configurations loaded to find a matching project ID.
Source code in sereto/project.py
132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |