Skip to content

Recommended

LicenseRecommended

Recommended licenses:

Examples:

# adding a Creative Commons license to a file
resource = resource.add_file(
    filename="images/cat.jpg",
    license=xmllib.LicenseRecommended.CC.BY,
    copyright_holder="Meow University",
    authorship=["Kitty Meow"],
)

# adding a DSP license to a file
resource = resource.add_file(
    filename="images/dog.jpg",
    license=xmllib.LicenseRecommended.DSP.PUBLIC_DOMAIN,
    copyright_holder="Bark University",
    authorship=["Bark McDog"],
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/licenses/recommended.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class LicenseRecommended:
    """
    Recommended licenses:

    - `DSP`: Licenses created and curated by DaSCH, [see `DSP` for details.](https://docs.dasch.swiss/latest/DSP-TOOLS/xmllib-api-reference/licenses/recommended/#xmllib.models.licenses.recommended.DSP)
    - `CC`: Creative Commons licenses, [see `CC` for details.](https://docs.dasch.swiss/latest/DSP-TOOLS/xmllib-api-reference/licenses/recommended/#xmllib.models.licenses.recommended.CC)

    Examples:
        ```python
        # adding a Creative Commons license to a file
        resource = resource.add_file(
            filename="images/cat.jpg",
            license=xmllib.LicenseRecommended.CC.BY,
            copyright_holder="Meow University",
            authorship=["Kitty Meow"],
        )
        ```

        ```python
        # adding a DSP license to a file
        resource = resource.add_file(
            filename="images/dog.jpg",
            license=xmllib.LicenseRecommended.DSP.PUBLIC_DOMAIN,
            copyright_holder="Bark University",
            authorship=["Bark McDog"],
        )
        ```
    """

    CC: type[CC]
    DSP: type[DSP]

CC

Bases: License, StrEnum

Pre-defined and recommended Creative Commons licenses:

Examples:

# adding a Creative Commons license to a file
resource = resource.add_file(
    filename="images/dog.jpg",
    license=xmllib.LicenseRecommended.CC.BY_NC_ND,
    copyright_holder="Bark University",
    authorship=["Bark McDog"],
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/licenses/recommended.py 
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
class CC(License, StrEnum):
    """
    Pre-defined and recommended [Creative Commons licenses:](https://creativecommons.org/share-your-work/)

    - `BY`: [Attribution 4.0](https://creativecommons.org/licenses/by/4.0/)
    - `BY_SA`: [Attribution-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/)
    - `BY_NC`: [Attribution-NonCommercial 4.0](https://creativecommons.org/licenses/by-nc/4.0/)
    - `BY_NC_SA`: [Attribution-NonCommercial-ShareAlike 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)
    - `BY_ND`: [Attribution-NoDerivatives 4.0](https://creativecommons.org/licenses/by-nd/4.0/)
    - `BY_NC_ND`: [Attribution-NonCommercial-NoDerivatives 4.0](https://creativecommons.org/licenses/by-nc-nd/4.0/)

    Examples:
        ```python
        # adding a Creative Commons license to a file
        resource = resource.add_file(
            filename="images/dog.jpg",
            license=xmllib.LicenseRecommended.CC.BY_NC_ND,
            copyright_holder="Bark University",
            authorship=["Bark McDog"],
        )
        ```
    """

    BY = "http://rdfh.ch/licenses/cc-by-4.0"
    BY_SA = "http://rdfh.ch/licenses/cc-by-sa-4.0"
    BY_NC = "http://rdfh.ch/licenses/cc-by-nc-4.0"
    BY_NC_SA = "http://rdfh.ch/licenses/cc-by-nc-sa-4.0"
    BY_ND = "http://rdfh.ch/licenses/cc-by-nd-4.0"
    BY_NC_ND = "http://rdfh.ch/licenses/cc-by-nc-nd-4.0"

DSP

Bases: License, StrEnum

Pre-defined and recommended licenses created and curated by DaSCH:

  • AI_GENERATED: AI-Generated Content - Not Protected by Copyright
  • UNKNOWN: Unknown License - Ask Copyright Holder for Permission
  • PUBLIC_DOMAIN: Public Domain - Not Protected by Copyright

Examples:

# adding a DSP license to a file
resource = resource.add_file(
    filename="images/cat.jpg",
    license=xmllib.LicenseRecommended.DSP.PUBLIC_DOMAIN,
    copyright_holder="Meow University",
    authorship=["Kitty Meow"],
)
Source code in dsp/dsp-tools/src/dsp_tools/xmllib/models/licenses/recommended.py 
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
class DSP(License, StrEnum):
    """
    Pre-defined and recommended licenses created and curated by DaSCH:

    - `AI_GENERATED`: AI-Generated Content - Not Protected by Copyright
    - `UNKNOWN`: Unknown License - Ask Copyright Holder for Permission
    - `PUBLIC_DOMAIN`: Public Domain - Not Protected by Copyright

    Examples:
        ```python
        # adding a DSP license to a file
        resource = resource.add_file(
            filename="images/cat.jpg",
            license=xmllib.LicenseRecommended.DSP.PUBLIC_DOMAIN,
            copyright_holder="Meow University",
            authorship=["Kitty Meow"],
        )
        ```
    """

    AI_GENERATED = "http://rdfh.ch/licenses/ai-generated"
    UNKNOWN = "http://rdfh.ch/licenses/unknown"
    PUBLIC_DOMAIN = "http://rdfh.ch/licenses/public-domain"