Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance documentation and actionability of license information #1840

Open
cthoyt opened this issue Apr 19, 2022 · 1 comment
Open

Enhance documentation and actionability of license information #1840

cthoyt opened this issue Apr 19, 2022 · 1 comment
Labels
documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools ontology metadata Issues related to ontology metadata

Comments

@cthoyt
Copy link
Collaborator

cthoyt commented Apr 19, 2022

While an ontology can contain licensing information in its own metadata, that's not the typical place people look for license text while browsing repositories on GitHub - it's desirable to have a file called LICENSE in the root of the repository that has standard license text as well. This is so ubiquitous, that GitHub even parses these and structures the metadata so it's accessible through the GitHub API.

I'm going to write a script that scrapes the OBO Foundry ontologies' repos and auto-generates PRs with the appropriate license text. I'll refer back to this issue and update this text with more information.

The code I'm using to automate creating PRs
import pandas as pd
import webbrowser
from bioregistry.external.obofoundry import get_obofoundry

MAPPING = {
    "CC BY 4.0": "cc-by-4.0",
    "CC0 1.0": "cc0-1.0",
}


def main():
    df = pd.read_csv("data/data.tsv", sep='\t')
    prefixes = dict(df.loc[df.license.isna(), ["prefix", "default_branch"]].values)
    obo = get_obofoundry()
    for prefix, default_branch in prefixes.items():
        data = obo[prefix]
        repository = data["repository"].rstrip("/")
        if "github" not in repository:
            continue
        ontology_license = data["license"]
        key = MAPPING.get(ontology_license)
        if not key:
            continue
        url = f"{repository}/community/license/new?branch={default_branch}&template={key}"
        webbrowser.open_new_tab(url)


if __name__ == '__main__':
    main()
The standard text I'm using in the PRs:
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: https://github.com/OBOFoundry/OBOFoundry.github.io/issues/1840.
cthoyt added a commit to cthoyt/c-elegans-development-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/plant-trait-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/RS-Rat-Strain-Ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/plant-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/plant-experimental-conditions-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/PDRO that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/provisional_cell_ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/ornaseq that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/opmi that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/OPL that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/OOSTT that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/Ontology-for-Nutritional-Studies that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/ohpi that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC BY 4.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/pco that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/ontology-metadata that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/bio-attribute-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/MMO-Measurement-Method-Ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/miapa that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/hao that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/fungal-anatomy-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/dicty-phenotype-ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/COB that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/CMO-Clinical-Measurement-Ontology that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/Collembola that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
cthoyt added a commit to cthoyt/cdao that referenced this issue Apr 19, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
@matentzn
Copy link
Contributor

This is totally crazy and totally awesome, both at the same time.

@nlharris nlharris added ontology metadata Issues related to ontology metadata documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools labels Apr 20, 2022
hlapp pushed a commit to evoinfo/miapa that referenced this issue Apr 25, 2022
This pull request is part of an initiative to make the licensing information about OBO Foundry ontologies more actionable.

While this ontology contains licensing information in its metadata, GitHub is not aware of the license unless you create a `LICENSE` file with standardized text. This PR creates a `LICENSE` file with the standard text for the CC0 1.0 license. 

More information about this initiative and further discussion is taking place here: OBOFoundry/OBOFoundry.github.io#1840.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues related to documentation presented on the website or relevant to Foundry-provided tools ontology metadata Issues related to ontology metadata
Projects
None yet
Development

No branches or pull requests

3 participants