updated README

Author: kurzum

README.md

@@ -1,11 +1,77 @@
 # Databus Client Python
 
-## Install
+## Quickstart Example
+Commands to download the DBpedia Knowledge Graphs generated by Live Fusion.
+DBpedia Live Fusion publishes two different kinds of KGs:
+
+1. Open Core Knowledge Graphs under CC-BY-SA license, open with copyleft/share-alike, no registration needed
+2. Industry Knowledge Graphs under BUSL 1.1 license, unrestricted for research and experimentation, commercial license for productive use, free registration needed. 
+ 
+
+### Registration (Access Token)
+
+1. If you do not have a DBpedia Account yet (Forum/Databus), please register at https://account.dbpedia.org  
+2. Login at https://account.dbpedia.org and create your token.
+3. Save the token to a file `vault-token.dat`.
+
+### Docker vs. Python
+The databus-python-client comes as **docker** or **python** with these patterns.
+`$DOWNLOADTARGET` can be any Databus URI including collections OR SPARQL query (or several thereof). Details are documented below.
 ```bash
+# Docker
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download $DOWNLOADTARGET --token vault-token.dat
+# Python
 python3 -m pip install databusclient
+databusclient download $DOWNLOADTARGET --token vault-token.dat
+```
+
+### Download Live Fusion KG Snapshot (BUSL 1.1, registration needed)
+TODO One slogan sentence. [More information](https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-kg-snapshot)
+```bash
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-kg-snapshot --token vault-token.dat
+```
+
+### Download Enriched Knowledge Graphs (BUSL 1.1, registration needed)
+**DBpedia Wikipedia Extraction Enriched**
+TODO One slogan sentence and link
+Currently EN DBpedia only. 
+
+```bash
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia-enterprise/dbpedia-wikipedia-kg-enriched-snapshot --token vault-token.dat
+```
+**DBpedia Wikidata Extraction Enriched**
+TODO One slogan sentence and link
+
+```bash
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia-enterprise/dbpedia-wikidata-kg-enriched-snapshot --token vault-token.dat
 ```
 
+### Download DBpedia Wikipedia Knowledge Graphs (CC-BY-SA, no registration needed)
+TODO One slogan sentence and link
+
+```bash
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia/dbpedia-wikipedia-kg-snapshot 
+```
+### Download DBpedia Wikidata Knowledge Graphs (CC-BY-SA, no registration needed)
+TODO One slogan sentence and link
+
+```bash
+docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia/dbpedia-wikidata-kg-snapshot 
+```
+
+## Docker Image Usage
+
+A docker image is available at [dbpedia/databus-python-client](https://hub.docker.com/r/dbpedia/databus-python-client). See [download section](#usage-of-docker-image) for details.
+
+
 ## CLI Usage
+
+**Installation**
+```bash
+python3 -m pip install databusclient
+```
+
+**Running**
 ```bash
 databusclient --help
 ```
@@ -26,47 +92,7 @@ Commands:
   download
 ```
 
-## Docker Image Usage
-
-A docker image is available at [dbpedia/databus-python-client](https://hub.docker.com/r/dbpedia/databus-python-client). See [download section](#usage-of-docker-image) for details.
-
-### Deploy command
-```
-databusclient deploy --help
-```
-```
-Usage: databusclient deploy [OPTIONS] DISTRIBUTIONS...
 
-Arguments:
-  DISTRIBUTIONS...  distributions in the form of List[URL|CV|fileext|compression|sha256sum:contentlength] where URL is the
-                    download URL and CV the key=value pairs (_ separted)
-                    content variants of a distribution, fileExt and Compression can be set, if not they are inferred from the path  [required]
-
-Options:
-  --version-id TEXT   Target databus version/dataset identifier of the form <h
-                      ttps://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VE
-                      RSION>  [required]
-  --title TEXT        Dataset title  [required]
-  --abstract TEXT     Dataset abstract max 200 chars  [required]
-  --description TEXT  Dataset description  [required]
-  --license TEXT      License (see dalicc.net)  [required]
-  --apikey TEXT       API key  [required]
-  --help              Show this message and exit.
-```
-Examples of using deploy command
-```
-databusclient deploy --version-id https://databus.dbpedia.org/user1/group1/artifact1/2022-05-18 --title title1 --abstract abstract1 --description description1 --license http://dalicc.net/licenselibrary/AdaptivePublicLicense10 --apikey MYSTERIOUS 'https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml|type=swagger'  
-```
-
-```
-databusclient deploy --version-id https://dev.databus.dbpedia.org/denis/group1/artifact1/2022-05-18 --title "Client Testing" --abstract "Testing the client...." --description "Testing the client...." --license http://dalicc.net/licenselibrary/AdaptivePublicLicense10 --apikey MYSTERIOUS 'https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml|type=swagger'  
-```
-
-A few more notes for CLI usage:
-
-* The content variants can be left out ONLY IF there is just one distribution
-  * For complete inferred: Just use the URL with `https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml`
-  * If other parameters are used, you need to leave them empty like `https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml||yml|7a751b6dd5eb8d73d97793c3c564c71ab7b565fa4ba619e4a8fd05a6f80ff653:367116`
 
 ### Download command
 ```
@@ -132,6 +158,46 @@ databusclient download https://databus.dbpedia.org/dbpedia/collections/dbpedia-s
 databusclient download 'PREFIX dcat: <http://www.w3.org/ns/dcat#> SELECT ?x WHERE { ?sub dcat:downloadURL ?x . } LIMIT 10' --databus https://databus.dbpedia.org/sparql
 ```
 
+### Deploy command
+```
+databusclient deploy --help
+```
+```
+Usage: databusclient deploy [OPTIONS] DISTRIBUTIONS...
+
+Arguments:
+  DISTRIBUTIONS...  distributions in the form of List[URL|CV|fileext|compression|sha256sum:contentlength] where URL is the
+                    download URL and CV the key=value pairs (_ separted)
+                    content variants of a distribution, fileExt and Compression can be set, if not they are inferred from the path  [required]
+
+Options:
+  --version-id TEXT   Target databus version/dataset identifier of the form <h
+                      ttps://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VE
+                      RSION>  [required]
+  --title TEXT        Dataset title  [required]
+  --abstract TEXT     Dataset abstract max 200 chars  [required]
+  --description TEXT  Dataset description  [required]
+  --license TEXT      License (see dalicc.net)  [required]
+  --apikey TEXT       API key  [required]
+  --help              Show this message and exit.
+```
+Examples of using deploy command
+```
+databusclient deploy --version-id https://databus.dbpedia.org/user1/group1/artifact1/2022-05-18 --title title1 --abstract abstract1 --description description1 --license http://dalicc.net/licenselibrary/AdaptivePublicLicense10 --apikey MYSTERIOUS 'https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml|type=swagger'  
+```
+
+```
+databusclient deploy --version-id https://dev.databus.dbpedia.org/denis/group1/artifact1/2022-05-18 --title "Client Testing" --abstract "Testing the client...." --description "Testing the client...." --license http://dalicc.net/licenselibrary/AdaptivePublicLicense10 --apikey MYSTERIOUS 'https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml|type=swagger'  
+```
+
+A few more notes for CLI usage:
+
+* The content variants can be left out ONLY IF there is just one distribution
+  * For complete inferred: Just use the URL with `https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml`
+  * If other parameters are used, you need to leave them empty like `https://raw.githubusercontent.com/dbpedia/databus/master/server/app/api/swagger.yml||yml|7a751b6dd5eb8d73d97793c3c564c71ab7b565fa4ba619e4a8fd05a6f80ff653:367116`
+
+
+
 #### Authentication with vault
 
 For downloading files from the vault, you need to provide a vault token. See [getting-the-access-refresh-token](https://github.com/dbpedia/databus-vault-access?tab=readme-ov-file#step-1-getting-the-access-refresh-token) for details. You can come back here once you have a `vault-token.dat` file. To use it, just provide the path to the file with `--token /path/to/vault-token.dat`.