Skip to content

Commit cdbde87

Browse files
committed
Fix ref in docs. Review README. Update Changelog for 1.0.0
1 parent 9532522 commit cdbde87

4 files changed

Lines changed: 16 additions & 13 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Change log
22

3-
## Unreleased
3+
## Release 1.0.0 (2025-12-31)
44

55
Features:
66

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
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:
1010

1111
- **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).
1313
- **[voc4cat-template](https://github.com/nfdi4cat/voc4cat-template)**
14-
- A github project template for managing SKOS-vocabularies using a GitHub-based workflows including automation by gh-actions.
14+
- A GitHub project template for managing SKOS-vocabularies using a GitHub-based workflows including automation by gh-actions.
1515
- **[voc4cat](https://github.com/nfdi4cat/voc4cat)**
1616
- A SKOS vocabulary for the catalysis disciplines that uses the voc4cat workflow for real work.
1717

@@ -27,12 +27,15 @@ voc4cat was mainly developed to be used in gh-actions but it is also useful as a
2727
- Check xlsx vocabulary files for errors or incorrect use of IDs (voc4cat uses pydantic for this validation).
2828
- Generate documentation from SKOS/turtle vocabulary file using [pyLODE](https://github.com/RDFLib/pyLODE).
2929

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+
3033
### Installation
3134

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).
3336

34-
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/).
35-
Both simplify installing and managing python command line 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.
3639

3740
```bash
3841
uv tool install voc4cat
@@ -56,15 +59,15 @@ The available commands and options can be explored via the help system:
5659
voc4cat --help
5760
```
5861

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.
6164
To include it modify the command (for uv tool) to
6265

6366
```bash
6467
uv tool install "voc4cat[assistant]"
6568
```
6669

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.
6871

6972
To install including all development tools use `pip install .[dev]`.
7073

@@ -107,11 +110,11 @@ We highly appreciate your feedback. Please create an [issue on GitHub](https://g
107110

108111
Before you contribute code, we suggest to first create an issue to get early feedback on your ideas before you spend too much time.
109112

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).
111114

112115
## Contributors
113116

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).
115118

116119
**A big thanks to our GitHub contributors:**
117120

docs/migration-to-v1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ To generate the xlsx-representation of your vocabulary run
105105
voc4cat convert --config path/to/v1.0/idranges.toml --outdir outbox/ outbox/vocab.ttl
106106
```
107107

108-
If you want to use an xlsx-template, the command to run is
108+
You can include additional sheets from an xlsx-template by modifying the command to
109109

110110
```bash
111111
voc4cat convert --config path/to/v1.0/idranges.toml --template templates/your-template.xlsx --outdir outbox/ outbox/vocab.ttl

docs/user-guide/project-setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ This could for example be used to provide a help sheet.
153153

154154
Drop a custom template file `template_myvocab.xlsx` to the folder `templates/`.
155155
The sheets that you put into this template may not have the same name as any of the auto-generated sheets
156-
(see {ref}`list in migration guide <step-3-generate-v1-0-excel-template>`).
156+
(see {ref}`list in migration guide <step-4-generate-v1-0-excel-template>`).
157157

158158
(keeping-in-sync-with-the-template)=
159159
## Keeping in sync with the template

0 commit comments

Comments
 (0)