madmpy API Reference v1.0
Warning
This API is based on an old version of the RDA-DMP Common Standard. Read the latest API reference version of this documentation.
Welcome to the madmpy
API Reference. This documentation provides a comprehensive overview of the available modules, classes, and methods within the library. The madmpy
library is designed to facilitate the creation, validation, and management of Data Management Plans (DMPs) based on the RDA-DMP Common Standard. Whether you are integrating DMP functionalities into your system or exploring the different components of a DMP, this reference will help you understand and use the structures and parameters effectively.
Certification
Bases: str
, Enum
Enum representing the certification types for dataset distribution hosts.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 |
|
Contact
Bases: BaseModel
Represents the main contact person for a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
134 135 136 137 138 139 140 141 142 143 144 145 |
|
ContactIdentifier
Bases: BaseModel
Represents a unique identifier for the contact person in a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
123 124 125 126 127 128 129 130 131 132 |
|
Contributor
Bases: BaseModel
Represents a contributor in a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
308 309 310 311 312 313 314 315 316 317 318 319 320 321 |
|
ContributorIdentifier
Bases: BaseModel
Represents a unique identifier for a contributor.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
297 298 299 300 301 302 303 304 305 306 |
|
Cost
Bases: BaseModel
Represents a cost entry in a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
|
DMP
Bases: BaseModel
Represents a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
|
DMPIdentifier
Bases: BaseModel
Represents an identifier for the DMP itself.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
499 500 501 502 503 504 505 506 507 508 |
|
DataAccess
Bases: str
, Enum
Enum representing the access mode for datasets.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
164 165 166 167 168 169 170 171 172 173 174 175 |
|
Dataset
Bases: BaseModel
Represents a dataset within a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 |
|
DatasetIdentifier
Bases: BaseModel
Represents an identifier for a dataset.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
451 452 453 454 455 456 457 458 459 460 |
|
Distribution
Bases: BaseModel
Represents a dataset distribution, providing technical information on a specific instance of data.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 |
|
Funding
Bases: BaseModel
Represents the funding details associated with a project.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
532 533 534 535 536 537 538 539 540 541 542 543 |
|
FundingIdentifier
Bases: BaseModel
Represents the identifier of a funder.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
510 511 512 513 514 515 516 517 518 519 |
|
FundingStatus
Bases: str
, Enum
Enum representing the possible funding statuses.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
282 283 284 285 286 287 288 289 290 291 292 293 294 295 |
|
GrantIdentifier
Bases: BaseModel
Represents the identifier of a funding grant.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
521 522 523 524 525 526 527 528 529 530 |
|
Host
Bases: BaseModel
Represents a dataset distribution host in a DMP. Information about the QoS provided by the infrastructure (e.g., repository) where data is stored.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 |
|
License
Bases: BaseModel
Represents a license applied to a dataset distribution.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
367 368 369 370 371 372 373 374 375 376 |
|
Metadata
Bases: BaseModel
Represents metadata standards used in a dataset.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
416 417 418 419 420 421 422 423 424 425 426 427 |
|
MetadataIdentifier
Bases: BaseModel
Represents an identifier for a metadata standard used in a dataset.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
405 406 407 408 409 410 411 412 413 414 |
|
PidSystem
Bases: str
, Enum
Enum representing the Persistent Identifier (PID) systems used for dataset distribution hosts.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 |
|
Project
Bases: BaseModel
Represents a project related to a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 |
|
SecurityPrivacy
Bases: BaseModel
Represents security and privacy measures applied to the dataset.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
429 430 431 432 433 434 435 436 437 438 |
|
TechnicalResource
Bases: BaseModel
Represents technical resources needed to implement a DMP.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
440 441 442 443 444 445 446 447 448 449 |
|
YesNoUnknown
Bases: str
, Enum
Enum representing a three-state option to indicate if a feature or option is supported.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
245 246 247 248 249 250 251 252 253 254 255 256 |
|
contact_id_type
Bases: str
, Enum
Enum for allowed contact identifier types.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
93 94 95 96 97 98 99 100 101 102 103 104 105 106 |
|
contributor_id_type
Bases: str
, Enum
Enum for allowed contributor identifier types.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
|
dmp_dataset_id_type
Bases: str
, Enum
Enum for allowed DMP dataset identifier types.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
|
funding_id_type
Bases: str
, Enum
Enum representing the allowed identifier types for funders.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
258 259 260 261 262 263 264 265 266 267 268 269 |
|
grant_id_type
Bases: str
, Enum
Enum representing the allowed identifier types for grants.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
271 272 273 274 275 276 277 278 279 280 |
|
metadata_id_type
Bases: str
, Enum
Enum for allowed metadata identifier types.
Parameters: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
82 83 84 85 86 87 88 89 90 91 |
|
extract_identifier(url, id_type)
Extracts the identifier from a URL based on the specified type.
Parameters: |
|
---|
Returns: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 |
|
validate_id(value)
Validates an identifier.
Parameters: |
|
---|
Raises: |
|
---|
Returns: |
|
---|
Source code in src/madmpy/v1_0/dmp.py
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 |
|