Skip to content

Commit 38badae

Browse files
committed
Add separate README for PyPI and me as another contact
1 parent a2689c5 commit 38badae

2 files changed

Lines changed: 47 additions & 1 deletion

File tree

README_pypkg.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# dcat_ap_plus
2+
3+
Extension of the DCAT Application Profile (DCAT-AP) that adds links to use-case specific context. It enables describing:
4+
5+
- which entities or activities were evaluated (the dataset is about),
6+
- which activity generated the dataset, including instruments, environment (e.g., lab), and plan,
7+
- which qualitative and quantitative characteristics were attributed to evaluated entities/activities and used instruments.
8+
9+
This package ships the LinkML-generated Python datamodel for the schema.
10+
Two versions of the datamodel are provided: one using Python dataclasses and another using Pydantic.
11+
12+
## Installation
13+
14+
```powershell
15+
pip install dcat_ap_plus
16+
```
17+
18+
Requires Python >= 3.9, < 4.0.
19+
20+
## Quick start
21+
22+
```python
23+
import dcat_ap_plus
24+
print(dcat_ap_plus.__version__)
25+
26+
# Work with the generated datamodel (Python dataclasses)
27+
from dcat_ap_plus.datamodel.dcat_ap_plus import Dataset, DataGeneratingActivity
28+
29+
ds = Dataset(
30+
id="ex:dataset1",
31+
title="Example dataset",
32+
description="A minimal dataset for quickstart.",
33+
was_generated_by=[DataGeneratingActivity(id="ex:act1")],
34+
)
35+
print(ds)
36+
```
37+
38+
## Documentation
39+
40+
- Project docs and schema reference: <https://nfdi-de.github.io/dcat-ap-plus>
41+
- Source code: <https://github.com/dalito/dcat-ap-plus>
42+
43+
## License
44+
45+
MIT License. See the bundled `LICENSE` file for details.

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,12 @@ build-backend = "hatchling.build"
66
name = "dcat_ap_plus"
77
description = "This metadata schema is an Extension of the DCAT Application Profile for Providing Links to Use-case Specific Context. It allows to provide additional metadata regarding: which kind(s) of entity(s) or activity(s) were evaluated (the dcat:Dataset is about), which kind of activity generated the dcat:Dataset, which kind of instruments were used in the dataset generating activity, in which surrounding (e.g. a laboratory) and according to which plan the dataset generating activity took place, as well as regarding which kind(s) of qualitative and quantitative characteristic were attributed to the evaluated entity or evaluated activity and to the used instruments."
88
authors = [
9+
{name = "David Linke", email = "david.linke@catalysis.de"},
910
{name = "Philip Strömert", email = "philip.stroemert@tib.eu"},
1011
]
1112
license = "MIT"
1213
license-files = ["LICENSE"]
13-
readme = "README.md"
14+
readme = "README_pypkg.md"
1415
requires-python = ">=3.9,<4.0"
1516
dynamic = ["version"]
1617

0 commit comments

Comments
 (0)