dalia_dif 0.0.15__tar.gz

dalia_dif-0.0.15/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Charles Tapley Hoyt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dalia_dif-0.0.15/PKG-INFO

@@ -0,0 +1,468 @@
+Metadata-Version: 2.4
+Name: dalia_dif
+Version: 0.0.15
+Summary: Tools for DALIA's data model for open educational resources
+Keywords: snekpack,cookiecutter,open educational resources,educational resources,training
+Author: Charles Tapley Hoyt
+Author-email: Charles Tapley Hoyt <cthoyt@gmail.com>
+License-File: LICENSE
+Classifier: Development Status :: 1 - Planning
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Pytest
+Classifier: Framework :: tox
+Classifier: Framework :: Sphinx
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Typing :: Typed
+Requires-Dist: click
+Requires-Dist: pydantic
+Requires-Dist: pydantic-extra-types[pycountry]
+Requires-Dist: pydantic-metamodel
+Requires-Dist: pystow
+Requires-Dist: rdflib
+Requires-Dist: tqdm
+Requires-Dist: curies
+Requires-Dist: base32-crockford
+Requires-Dist: matplotlib ; extra == 'export'
+Requires-Dist: seaborn ; extra == 'export'
+Requires-Dist: pandas ; extra == 'export'
+Requires-Dist: pandas ; extra == 'fti'
+Maintainer: Charles Tapley Hoyt
+Maintainer-email: Charles Tapley Hoyt <cthoyt@gmail.com>
+Requires-Python: >=3.10
+Project-URL: Bug Tracker, https://github.com/data-literacy-alliance/dalia-dif/issues
+Project-URL: Documentation, https://dalia-dif.readthedocs.io
+Project-URL: Homepage, https://github.com/data-literacy-alliance/dalia-dif
+Project-URL: Repository, https://github.com/data-literacy-alliance/dalia-dif.git
+Provides-Extra: export
+Provides-Extra: fti
+Description-Content-Type: text/markdown
+
+<!--
+<p align="center">
+  <img src="https://github.com/data-literacy-alliance/dalia-dif/raw/main/docs/source/logo.png" height="150">
+</p>
+-->
+
+<h1 align="center">
+  DALIA Interaction Format (DIF)
+</h1>
+
+<p align="center">
+    <a href="https://github.com/data-literacy-alliance/dalia-dif/actions/workflows/tests.yml">
+        <img alt="Tests" src="https://github.com/data-literacy-alliance/dalia-dif/actions/workflows/tests.yml/badge.svg" /></a>
+    <a href="https://pypi.org/project/dalia_dif">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/dalia_dif" /></a>
+    <a href="https://pypi.org/project/dalia_dif">
+        <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/dalia_dif" /></a>
+    <a href="https://github.com/data-literacy-alliance/dalia-dif/blob/main/LICENSE">
+        <img alt="PyPI - License" src="https://img.shields.io/pypi/l/dalia_dif" /></a>
+    <a href='https://dalia_dif.readthedocs.io/en/latest/?badge=latest'>
+        <img src='https://readthedocs.org/projects/dalia_dif/badge/?version=latest' alt='Documentation Status' /></a>
+    <a href="https://codecov.io/gh/data-literacy-alliance/dalia-dif/branch/main">
+        <img src="https://codecov.io/gh/data-literacy-alliance/dalia-dif/branch/main/graph/badge.svg" alt="Codecov status" /></a>  
+    <a href="https://github.com/cthoyt/cookiecutter-python-package">
+        <img alt="Cookiecutter template from @cthoyt" src="https://img.shields.io/badge/Cookiecutter-snekpack-blue" /></a>
+    <a href="https://github.com/astral-sh/ruff">
+        <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json" alt="Ruff" style="max-width:100%;"></a>
+    <a href="https://github.com/data-literacy-alliance/dalia-dif/blob/main/.github/CODE_OF_CONDUCT.md">
+        <img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"/></a>
+    <a href="https://doi.org/10.5281/zenodo.17532540">
+        <img src="https://zenodo.org/badge/DOI/10.5281/zenodo.17532540.svg" alt="DOI"></a>
+</p>
+
+The DALIA Interaction Format (DIF) v1.3 is the data model and CSV-based input
+format for open educational resources (OERs) in the DALIA OER platform.
+
+This repository contains an implementation of the data model in Pydantic, a
+workflow for serializing to RDF based on
+[pydantic-metamodel](https://github.com/cthoyt/pydantic-metamodel), a CSV
+reader, and a command line validator.
+
+A tutorial/guide for curating OERs in a tabular form (CSV) can be found
+[here](docs/curation.md).
+
+```mermaid
+graph LR
+    er[Educational Resource] -- "supported by (0..*)" --> community[Community]
+    er -- "recommended by by (0..*)" --> community
+    er -- "has author (1..*)" --> author[Author]
+    er -- "has discipline (0..*)" --> discipline[Discipline]
+    er -- "type (1)" --> lrt[Learning Resource Type]
+    er -- "has media type (0..*)" --> mediatype[Media Type]
+    er -- "has target group (0..*)" --> tg[Target Group]
+    er -- "requires (0..*)" --> pl[Proficiency Level]
+```
+
+## 💪 Getting Started
+
+The `dalia_dif` command line tool can be used from the console with to validate
+CSV files (both local and remote).
+
+```console
+$ dalia_dif validate https://raw.githubusercontent.com/NFDI4BIOIMAGE/training/refs/heads/main/docs/export/DALIA_training_materials.csv
+```
+
+Serialize to RDF with `dalia_dif convert`. It guesses the format based on the
+file extension, right now `.ttl` and `.jsonl` are supported.
+
+```console
+$ dalia_dif convert -o output.ttl https://raw.githubusercontent.com/NFDI4BIOIMAGE/training/refs/heads/main/docs/export/DALIA_training_materials.csv
+```
+
+```console
+$ dalia_dif convert -o output.jsonl https://raw.githubusercontent.com/NFDI4BIOIMAGE/training/refs/heads/main/docs/export/DALIA_training_materials.csv
+```
+
+Using the data model:
+
+```python
+from pydantic_metamodel.api import PredicateObject
+
+from dalia_dif.dif13.model import AuthorDIF13, EducationalResourceDIF13, OrganizationDIF13
+from dalia_dif.dif13.picklists import (
+    MEDIA_TYPES,
+    PROFICIENCY_LEVELS,
+    RELATED_WORKS_RELATIONS,
+    TARGET_GROUPS,
+    LEARNING_RESOURCE_TYPES,
+)
+from dalia_dif.namespace import DALIA_COMMUNITY, HSFS
+
+resource = EducationalResourceDIF13(
+    uuid="b37ddf6e-f136-4230-8418-faf18c4c34d2",
+    title="Chemotion ELN Instruction Videos",
+    description="Chemotion ELN Instruction Videos Chemotion[1] is an open source "
+                "system for storing and managing experiments and molecular data in "
+                "chemistry and its related sciences.",
+    links=["https://doi.org/10.5281/zenodo.7634481"],
+    authors=[
+        AuthorDIF13(given_name="Fabian", family_name="Fink", orcid="0000-0002-1863-2087"),
+        AuthorDIF13(given_name="Salim", family_name="Benjamaa", orcid="0000-0001-6215-6834"),
+        AuthorDIF13(given_name="Nicole", family_name="Parks", orcid="0000-0002-6243-2840"),
+        AuthorDIF13(
+            given_name="Alexander", family_name="Hoffmann", orcid="0000-0002-9647-8839"
+        ),
+        AuthorDIF13(
+            given_name="Sonja", family_name="Herres-Pawlis", orcid="0000-0002-4354-4353"
+        ),
+    ],
+    license="https://creativecommons.org/licenses/by/4.0",
+    supporting_communities=[],
+    recommending_communities=[
+        DALIA_COMMUNITY["bead62a8-c3c2-46d6-9eb1-ffeaba38d5bf"],  # NFDI4Chem
+    ],
+    disciplines=[
+        HSFS["n40"],  # chemistry
+    ],
+    file_formats=[
+        ".mp4",
+    ],
+    keywords=["research data management", "NFDI", "RDM", "FDM", "NFDI4Chem", "Chemotion"],
+    languages=["eng"],
+    learning_resource_types=[
+        LEARNING_RESOURCE_TYPES["tutorial"],
+    ],
+    media_types=[
+        MEDIA_TYPES["video"],
+    ],
+    proficiency_levels=[
+        PROFICIENCY_LEVELS["novice"],
+    ],
+    publication_date="2023-02-13",
+    target_groups=[
+        TARGET_GROUPS["student (ba)"],
+    ],
+    related_works=[
+        PredicateObject(
+            predicate=RELATED_WORKS_RELATIONS["isTranslationOf"],
+            object="https://id.dalia.education/learning-resource/20be255e-e2da-4f9c-90b3-5573d6a12619",
+        )
+    ],
+    file_size="703.2 MB",
+    version=None,
+)
+turtle_str = resource.model_dump_turtle()
+```
+
+## 🚀 Installation
+
+The most recent release can be installed from
+[PyPI](https://pypi.org/project/dalia_dif/) with uv:
+
+```console
+$ uv pip install dalia_dif
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install dalia_dif
+```
+
+The most recent code and data can be installed directly from GitHub with uv:
+
+```console
+$ uv pip install git+https://github.com/data-literacy-alliance/dalia-dif.git
+```
+
+or with pip:
+
+```console
+$ python3 -m pip install git+https://github.com/data-literacy-alliance/dalia-dif.git
+```
+
+## 👐 Contributing
+
+Contributions, whether filing an issue, making a pull request, or forking, are
+appreciated. See
+[CONTRIBUTING.md](https://github.com/data-literacy-alliance/dalia-dif/blob/master/.github/CONTRIBUTING.md)
+for more information on getting involved.
+
+## 👋 Attribution
+
+### ⚖️ License
+
+The code in this package is licensed under the MIT License.
+
+### 📖 Citation
+
+An abstract describing the DIF has been published in the proceedings of the
+2<sup>nd</sup> Conference on Research Data Infrastructure (CoRDI).
+
+```bibtex
+@misc{steiner2025,
+    author = {Steiner, Petra C. and Geiger, Jonathan D. and Fuhrmans, Marc and Amer Desouki, Abdelmoneim and Hüppe, Henrika M.},
+    title = {The Revised DALIA Interchange Format - New Picklists for Describing Open Educational Resources},
+    month = aug,
+    year = 2025,
+    publisher = {Zenodo},
+    doi = {10.5281/zenodo.16736170},
+    url = {https://doi.org/10.5281/zenodo.16736170},
+}
+```
+
+### 🎁 Support
+
+This project has been supported by the following organizations (in alphabetical
+order):
+
+- [NFDI4Chem](https://www.nfdi4chem.de)
+- [NFDI4Culture](https://nfdi4culture.de)
+- [NFDI4Ing](https://nfdi4ing.de)
+
+### 💰 Funding
+
+This project has been supported by the following grants:
+
+| Funding Body                                                       | Program | Grant Number |
+| ------------------------------------------------------------------ | ------- | ------------ |
+| German Federal Ministry of Research, Technology, and Space (BMFTR) |         | 16DWWQP07    |
+| EU Capacity Building and Resilience Facility                       |         | 16DWWQP07    |
+
+### 🍪 Cookiecutter
+
+This package was created with
+[@audreyfeldroy](https://github.com/audreyfeldroy)'s
+[cookiecutter](https://github.com/cookiecutter/cookiecutter) package using
+[@cthoyt](https://github.com/cthoyt)'s
+[cookiecutter-snekpack](https://github.com/cthoyt/cookiecutter-snekpack)
+template.
+
+## 🛠️ For Developers
+
+<details>
+  <summary>See developer instructions</summary>
+
+The final section of the README is for if you want to get involved by making a
+code contribution.
+
+### Development Installation
+
+To install in development mode, use the following:
+
+```console
+$ git clone git+https://github.com/data-literacy-alliance/dalia-dif.git
+$ cd dalia-dif
+$ uv pip install -e .
+```
+
+Alternatively, install using pip:
+
+```console
+$ python3 -m pip install -e .
+```
+
+### 🥼 Testing
+
+After cloning the repository and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, the
+unit tests in the `tests/` folder can be run reproducibly with:
+
+```console
+$ tox -e py
+```
+
+Additionally, these tests are automatically re-run with each commit in a
+[GitHub Action](https://github.com/data-literacy-alliance/dalia-dif/actions?query=workflow%3ATests).
+
+### 📖 Building the Documentation
+
+The documentation can be built locally using the following:
+
+```console
+$ git clone git+https://github.com/data-literacy-alliance/dalia-dif.git
+$ cd dalia-dif
+$ tox -e docs
+$ open docs/build/html/index.html
+```
+
+The documentation automatically installs the package as well as the `docs` extra
+specified in the [`pyproject.toml`](pyproject.toml). `sphinx` plugins like
+`texext` can be added there. Additionally, they need to be added to the
+`extensions` list in [`docs/source/conf.py`](docs/source/conf.py).
+
+The documentation can be deployed to [ReadTheDocs](https://readthedocs.io) using
+[this guide](https://docs.readthedocs.io/en/stable/intro/import-guide.html). The
+[`.readthedocs.yml`](.readthedocs.yml) YAML file contains all the configuration
+you'll need. You can also set up continuous integration on GitHub to check not
+only that Sphinx can build the documentation in an isolated environment (i.e.,
+with `tox -e docs-test`) but also that
+[ReadTheDocs can build it too](https://docs.readthedocs.io/en/stable/pull-requests.html).
+
+</details>
+
+## 🧑‍💻 For Maintainers
+
+<details>
+  <summary>See maintainer instructions</summary>
+
+### Initial Configuration
+
+#### Configuring ReadTheDocs
+
+[ReadTheDocs](https://readthedocs.org) is an external documentation hosting
+service that integrates with GitHub's CI/CD. Do the following for each
+repository:
+
+1. Log in to ReadTheDocs with your GitHub account to install the integration at
+   https://readthedocs.org/accounts/login/?next=/dashboard/
+2. Import your project by navigating to https://readthedocs.org/dashboard/import
+   then clicking the plus icon next to your repository
+3. You can rename the repository on the next screen using a more stylized name
+   (i.e., with spaces and capital letters)
+4. Click next, and you're good to go!
+
+#### Configuring Archival on Zenodo
+
+[Zenodo](https://zenodo.org) is a long-term archival system that assigns a DOI
+to each release of your package. Do the following for each repository:
+
+1. Log in to Zenodo via GitHub with this link:
+   https://zenodo.org/oauth/login/github/?next=%2F. This brings you to a page
+   that lists all of your organizations and asks you to approve installing the
+   Zenodo app on GitHub. Click "grant" next to any organizations you want to
+   enable the integration for, then click the big green "approve" button. This
+   step only needs to be done once.
+2. Navigate to https://zenodo.org/account/settings/github/, which lists all of
+   your GitHub repositories (both in your username and any organizations you
+   enabled). Click the on/off toggle for any relevant repositories. When you
+   make a new repository, you'll have to come back to this
+
+After these steps, you're ready to go! After you make "release" on GitHub (steps
+for this are below), you can navigate to
+https://zenodo.org/account/settings/github/repository/data-literacy-alliance/dalia-dif
+to see the DOI for the release and link to the Zenodo record for it.
+
+#### Registering with the Python Package Index (PyPI)
+
+The [Python Package Index (PyPI)](https://pypi.org) hosts packages so they can
+be easily installed with `pip`, `uv`, and equivalent tools.
+
+1. Register for an account [here](https://pypi.org/account/register)
+2. Navigate to https://pypi.org/manage/account and make sure you have verified
+   your email address. A verification email might not have been sent by default,
+   so you might have to click the "options" dropdown next to your address to get
+   to the "re-send verification email" button
+3. 2-Factor authentication is required for PyPI since the end of 2023 (see this
+   [blog post from PyPI](https://blog.pypi.org/posts/2023-05-25-securing-pypi-with-2fa/)).
+   This means you have to first issue account recovery codes, then set up
+   2-factor authentication
+4. Issue an API token from https://pypi.org/manage/account/token
+
+This only needs to be done once per developer.
+
+#### Configuring your machine's connection to PyPI
+
+This needs to be done once per machine.
+
+```console
+$ uv tool install keyring
+$ keyring set https://upload.pypi.org/legacy/ __token__
+$ keyring set https://test.pypi.org/legacy/ __token__
+```
+
+Note that this deprecates previous workflows using `.pypirc`.
+
+### 📦 Making a Release
+
+#### Uploading to PyPI
+
+After installing the package in development mode and installing `tox` with
+`uv tool install tox --with tox-uv` or `python3 -m pip install tox tox-uv`, run
+the following from the console:
+
+```console
+$ tox -e finish
+```
+
+This script does the following:
+
+1. Uses [bump-my-version](https://github.com/callowayproject/bump-my-version) to
+   switch the version number in the `pyproject.toml`, `CITATION.cff`,
+   `src/dalia_dif/version.py`, and [`docs/source/conf.py`](docs/source/conf.py)
+   to not have the `-dev` suffix
+2. Packages the code in both a tar archive and a wheel using
+   [`uv build`](https://docs.astral.sh/uv/guides/publish/#building-your-package)
+3. Uploads to PyPI using
+   [`uv publish`](https://docs.astral.sh/uv/guides/publish/#publishing-your-package).
+4. Push to GitHub. You'll need to make a release going with the commit where the
+   version was bumped.
+5. Bump the version to the next patch. If you made big changes and want to bump
+   the version by minor, you can use `tox -e bumpversion -- minor` after.
+
+#### Releasing on GitHub
+
+1. Navigate to https://github.com/data-literacy-alliance/dalia-dif/releases/new
+   to draft a new release
+2. Click the "Choose a Tag" dropdown and select the tag corresponding to the
+   release you just made
+3. Click the "Generate Release Notes" button to get a quick outline of recent
+   changes. Modify the title and description as you see fit
+4. Click the big green "Publish Release" button
+
+This will trigger Zenodo to assign a DOI to your release as well.
+
+### Updating Package Boilerplate
+
+This project uses `cruft` to keep boilerplate (i.e., configuration, contribution
+guidelines, documentation configuration) up-to-date with the upstream
+cookiecutter package. Install cruft with either `uv tool install cruft` or
+`python3 -m pip install cruft` then run:
+
+```console
+$ cruft update
+```
+
+More info on Cruft's update command is available
+[here](https://github.com/cruft/cruft?tab=readme-ov-file#updating-a-project).
+
+</details>