You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-10Lines changed: 13 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,9 +9,9 @@
9
9
For **[voc4cat](https://github.com/nfdi4cat/voc4cat)**, a term collection for catalysis created in [NFDI4Cat](https://www.nfdi4cat.org), we developed a **toolbox for collaboratively maintaining SKOS vocabularies on GitHub using Excel** (xlsx-files) as user-friendly interface. It consists of several parts:
10
10
11
11
-**voc4cat-tool** (this package)
12
-
- A command-line tool to convert vocabularies from Excel/xlsx to SKOS (turtle/rdf) and validate the vocabulary. Validation includes formal validation with SHACL-profiles but also additional checks. The `voc4cat` tool can be run locally but is also well suited for integration in CI-pipelines. It was inspired by [RDFlib/VocExcel](https://github.com/nfdi4cat/VocExcel). Parts of the vocexcel code base were merged into this repository (see git history).
12
+
- A command-line tool to convert vocabularies from Excel/xlsx to SKOS (turtle/rdf) and validate the vocabulary. Validation includes formal SHACL profile checks as well as additional custom validation. The `voc4cat` tool can be run locally but is also well suited for integration in CI-pipelines. It was inspired by [RDFLib/VocExcel](https://github.com/nfdi4cat/VocExcel). Parts of the VocExcel codebase were merged into this repository (see git history).
- A SKOS vocabulary for the catalysis disciplines that uses the voc4cat workflow for real work.
17
17
@@ -27,12 +27,15 @@ voc4cat was mainly developed to be used in gh-actions but it is also useful as a
27
27
- Check xlsx vocabulary files for errors or incorrect use of IDs (voc4cat uses pydantic for this validation).
28
28
- Generate documentation from SKOS/turtle vocabulary file using [pyLODE](https://github.com/RDFLib/pyLODE).
29
29
30
+
The RDF produced by 1.x version of voc4cat-tool is well aligned with the data model of [Skosmos 3](https://skosmos.org/) (even deprecations are correctly visualized).
31
+
We recommend Skosmos for providing an API to your vocabulary or if you want as a richer user interface than the static HTML documentation.
32
+
30
33
### Installation
31
34
32
-
voc4cat is platform independent and works on windows, linux and mac. It requires Python (3.10 or newer).
35
+
voc4cat is platform independent and works on Windows, Linux, and macOS. It requires Python (3.10 or newer).
33
36
34
-
If you only want to use the commandline interface it is strongly suggested to install with [uv tool](https://docs.astral.sh/uv/concepts/tools/) or [pipx](https://pypa.github.io/pipx/).
35
-
Both simplify installing and managing python commandline applications.
37
+
If you only want to use the command-line interface, it is strongly suggested to install with [uv tool](https://docs.astral.sh/uv/concepts/tools/) or [pipx](https://pypa.github.io/pipx/).
38
+
Both simplify installing and managing Python command-line applications.
36
39
37
40
```bash
38
41
uv tool install voc4cat
@@ -56,15 +59,15 @@ The available commands and options can be explored via the help system:
56
59
voc4cat --help
57
60
```
58
61
59
-
Optionally you may install the "assistant" which uses [sentence-transformers](https://sbert.net/) for concept similarity analysis.
60
-
This adds >100 MB to the download so we don't include it in the default installer.
62
+
You can optionally install the "assistant" which uses [sentence-transformers](https://sbert.net/) for concept similarity analysis.
63
+
This adds over 100 MB to the download so we don't include it in the default installer.
61
64
To include it modify the command (for uv tool) to
62
65
63
66
```bash
64
67
uv tool install "voc4cat[assistant]"
65
68
```
66
69
67
-
Alternatively you can `pip`-install voc4cat like any other Python package.
70
+
Alternatively, you can install voc4cat using `pip` like any other Python package.
68
71
69
72
To install including all development tools use `pip install .[dev]`.
70
73
@@ -107,11 +110,11 @@ We highly appreciate your feedback. Please create an [issue on GitHub](https://g
107
110
108
111
Before you contribute code, we suggest to first create an issue to get early feedback on your ideas before you spend too much time.
109
112
110
-
By contributing you agree that your contributions fall under the project´s BSD-3-Clause [license](LICENSE).
113
+
By contributing, you agree that your contributions are licensed under the project's BSD-3-Clause [license](LICENSE).
111
114
112
115
## Contributors
113
116
114
-
For details see the [Zenodo record](https://doi.org/10.5281/zenodo.8277925).
117
+
For details, see the [Zenodo record](https://doi.org/10.5281/zenodo.8277925).
0 commit comments