From f0edfd278784213b742012a8c7fcb727356cbcf8 Mon Sep 17 00:00:00 2001
From: Jesper Zedlitz <jesper@zedlitz.de>
Date: Fri, 5 Feb 2021 13:26:21 +0100
Subject: [PATCH] etwas Dokumentation Version 1.0
---
README.md | 34 ++++++++++++++++++++++++++++++++++
pom.xml | 2 +-
2 files changed, 35 insertions(+), 1 deletion(-)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..482c640
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# dcat-upload
+
+Ein Hilfsprogramm, mit dem man aus Java-Programmen heraus DCAT-AP.de konforme Metadaten in CKAN hochladen kann.
+
+
+## Abhängigkeit
+
+```xml
+<dependency>
+ <groupId>de.landsh.opendata</groupId>
+ <artifactId>dcat-uploader</artifactId>
+ <version>1.0</version>
+</dependency>
+```
+
+## Nutzung
+
+Es gibt ein low-level CKAN-API `de.landsh.opendata.ckan.CkanAPI` für die grundlegende Kommunikation mit CKAN. Hier wird auf Basis der CKAN-Konzepten *Package* und *Resource* gearbeitet, die in Java als `org.json.JSONObject` sichtbar werden. Für den Zugriff benötigt man die Basisadresse der des Portals und sein API-Key, den man in seinem CKAN-Profil einsehen kann, z.B. unter https://opendata-stage.schleswig-holstein.de/user/
+
+```java
+CkanAPI ckanAPI = new CkanAPI("https://opendata-stage.schleswig-holstein.de", new ApiKey("5f6c2da3-dfdc-4c88-a129-22acb129526b"));
+JSONObject dataset = readDataset( "schulen-2021-02-01");
+```
+
+Der `de.landsh.opendata.ckan.DcatUploader` arbeitet hingegen mit dem konzeptuellen Modell von DCAT-AP.de. Relevante Klassen sind *Dataset* und *Distribution*, die in Java als `org.apache.jena.rdf.model.Resource` sichtbar werden. Ein `DcatUpload` benötigt ein `CkanAPI` (siehe oben) für die CKAN-Instanz, mit der kommuniziert werden soll.
+
+Die Methode `upload` nimmt eine vollständig gefüllte RDF-Resources eines *Dataset* und legt diese samt *Distributionen* und *Collections* in CKAN an. Dateien von *Distributionen* werden derzeit noch nicht nach CKAN hochgeladen.
+
+```java
+CkanAPI ckanAPI = new CkanAPI("https://opendata-stage.schleswig-holstein.de", new ApiKey("5f6c2da3-dfdc-4c88-a129-22acb129526b"));
+DcatUploader uploader = new DcatUploader(ckanAPI);
+Resourse dataset = ...
+uploader.upload(dataset);
+```
diff --git a/pom.xml b/pom.xml
index be15681..aa01f22 100644
--- a/pom.xml
+++ b/pom.xml
@@ -6,7 +6,7 @@
<groupId>de.landsh.opendata</groupId>
<artifactId>dcat-uploader</artifactId>
- <version>1.0-SNAPSHOT</version>
+ <version>1.0</version>
<build>
<plugins>
--
GitLab