alanorth/iseal-core
1
0
Fork 0
mirror of https://github.com/ISEAL-Community/iseal-core.git synced 2024-11-21 22:35:01 +01:00
Code Issues Projects Releases Wiki Activity
ISEAL Core Metadata Set
156 Commits 2 Branches 0 Tags 6 MiB
HTML 100%
9116734205
Go to file
Alan Orth 9116734205
.github/workflows/pages.yml: use Python 3.10 
It's what I use locally and it's the latest supported version so it
will let this project work a bit longer as time goes on if we start
with the latest version possible.
2022-01-06 13:50:08 +02:00
.github/workflows .github/workflows/pages.yml: use Python 3.10 2022-01-06 13:50:08 +02:00
data Regenerate controlled vocabularies 2022-01-06 12:40:20 +02:00
site Automated commit with site updates 2022-01-06 10:43:37 +00:00
util Add util/export-controlled-vocabularies.py 2022-01-06 12:40:20 +02:00
.gitignore .gitignore: ignore Python virtualenv 2021-12-06 21:29:22 +02:00
idds.ttl rdf regenerate 2021-12-13 14:20:13 +01:00
LICENSE Add license notice 2021-12-02 10:40:49 +02:00
poetry.lock poetry.lock: run poetry update 2022-01-06 13:48:02 +02:00
pyproject.toml pyproject.toml: add csvkit 2021-12-16 21:23:48 +02:00
README.md README.md: update TODO 2022-01-06 13:02:26 +02:00
requirements.txt Update requirements.txt 2022-01-06 13:49:46 +02:00
screenshot.png README.md: add more information 2021-12-06 21:28:18 +02:00
setup.cfg Add setup.cfg for isort 2021-11-01 08:21:32 +02:00

README.md

ISEAL Core Metadata Set

The ISEAL Core Metadata Set (ISEAL Core) is a set of structured terms and vocabularies that can be used as metadata to describe, share, and reuse different digital resources across the ISEAL Community and broader set of stakeholders. The resources described using the ISEAL Core are those that sustainability systems typically collect, curate, manage, use, publish and archive. They may be datasets, published research, certificates, videos, images, maps, or other organizational documentation.

Screenshot of ISEAL Core Metadata Set documentation

You can see a user-friendly version of the schema here.

Requirements

  • Python 3.7+ (for parsing the schema)
  • Node.js 12+ (for generating the HTML documentation site)

Python Setup

Create a Python 3 (3.7+) virtual environment and install the requirements:

$ python3 -m venv virtualenv
$ source virtualenv/bin/activate
$ pip install -r requirements.txt

Then run the utility scripts to parse the schemas:

$ ./util/generate-hugo-content.py -i ./data/iseal-core.csv --clean -d
$ ./util/generate-hugo-content.py -i data/fsc.csv -d

Node.js Setup

To generate the HTML documentation site:

$ cd site
$ npm install
$ npm run build

TODO

  • Repository
    • Add more information and instructions to README.md
  • Schema
    • Remove combined "latLong" fields (they can be inferred from the separate fields)
    • Remove controlled vocabularies from the schema CSVs
  • Site
    • Change "Suggested element" to "DSpace mapping"?

License

This project's source code is licensed under the GNU General Public License v3.0. This project's text and graphics are licensed under the Creative Commons Attribution Share Alike 4.0 International license.