Skip to content

Commit 9806437

Browse files
committed
updated README.md
1 parent 0455c22 commit 9806437

File tree

1 file changed

+46
-36
lines changed

1 file changed

+46
-36
lines changed

README.md

Lines changed: 46 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -158,6 +158,30 @@ databusclient download https://databus.dbpedia.org/dbpedia/collections/dbpedia-s
158158
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
159159
```
160160

161+
#### Authentication with vault
162+
163+
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`.
164+
165+
Example:
166+
```
167+
databusclient download https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-snapshots/fusion/2025-08-23 --token vault-token.dat
168+
```
169+
170+
If vault authentication is required for downloading a file, the client will use the token. If no vault authentication is required, the token will not be used.
171+
172+
#### Usage of docker image
173+
174+
A docker image is available at [dbpedia/databus-python-client](https://hub.docker.com/r/dbpedia/databus-python-client). You can use it like this:
175+
176+
```
177+
docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia/mappings/mappingbased-literals/2022.12.01
178+
```
179+
If using vault authentication, make sure the token file is available in the container, e.g. by placing it in the current working directory.
180+
```
181+
docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-snapshots/fusion/2025-08-23/fusion_props=all_subjectns=commons-wikimedia-org_vocab=all.ttl.gz --token vault-token.dat
182+
```
183+
184+
161185
### Deploy command
162186
```
163187
databusclient deploy --help
@@ -195,10 +219,10 @@ Options:
195219
--remote TEXT rclone remote name (e.g., 'my-nextcloud')
196220
--path TEXT Remote path on Rclone Remote (e.g., 'datasets/mydataset')
197221
--help Show this message and exit.
198-
199222
```
200-
#### Examples of using deploy command
201-
##### Mode 1: Classic Deploy (Distributions)
223+
224+
#### Mode 1: Classic Deploy (Distributions)
225+
Example Calls:
202226
```
203227
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'
204228
```
@@ -213,11 +237,13 @@ A few more notes for CLI usage:
213237
* 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`
214238

215239

216-
##### Mode 2: Deploy with Metadata File
240+
#### Mode 2: Deploy with Metadata File
241+
242+
Use a JSON metadata file instead of command-line arguments to define all distributions.
243+
The `metadata.json` file should list all distributions along with their metadata.
244+
All files referenced in this file will be registered on the Databus.
217245

218-
Use a JSON metadata file to define all distributions.
219-
The metadata.json should list all distributions and their metadata.
220-
All files referenced there will be registered on the Databus.
246+
Example Call:
221247
```bash
222248
databusclient deploy \
223249
--metadata /home/metadata.json \
@@ -228,7 +254,8 @@ databusclient deploy \
228254
--license https://dalicc.net/licenselibrary/Apache-2.0 \
229255
--apikey "API-KEY"
230256
```
231-
Metadata file structure (file_format and compression are optional):
257+
258+
Metadata file structure:
232259
```json
233260
[
234261
{
@@ -243,17 +270,23 @@ Metadata file structure (file_format and compression are optional):
243270
"url": "https://cloud.example.com/remote.php/webdav/datasets/mydataset/example.csv.gz",
244271
"file_format": "csv",
245272
"compression": "gz"
246-
}
273+
},
274+
...
247275
]
248-
249276
```
277+
`file_format` and `compression` fields are optional.
278+
If omitted, the system attempts to detect them automatically.
250279

251280

252-
##### Mode 3: Upload & Deploy via Rclone
281+
#### Mode 3: Upload & Deploy via Rclone
253282

254-
Upload local files or folders to a Rclone remote and automatically deploy to DBpedia Databus.
255-
Rclone is required.
283+
Uploads local files or folders to an Rclone remote and automatically deploys them to the DBpedia Databus.
284+
**Rclone must be installed and configured.**
256285

286+
The `--remote` argument must match the name of the remote as registered in your Rclone configuration.
287+
The `--path` argument defines the destination path on the remote, relative to its base directory.
288+
289+
Example Call:
257290
```bash
258291
databusclient deploy \
259292
--remote my-nextcloud \
@@ -269,29 +302,6 @@ databusclient deploy \
269302
```
270303

271304

272-
#### Authentication with vault
273-
274-
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`.
275-
276-
Example:
277-
```
278-
databusclient download https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-snapshots/fusion/2025-08-23 --token vault-token.dat
279-
```
280-
281-
If vault authentication is required for downloading a file, the client will use the token. If no vault authentication is required, the token will not be used.
282-
283-
#### Usage of docker image
284-
285-
A docker image is available at [dbpedia/databus-python-client](https://hub.docker.com/r/dbpedia/databus-python-client). You can use it like this:
286-
287-
```
288-
docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia/mappings/mappingbased-literals/2022.12.01
289-
```
290-
If using vault authentication, make sure the token file is available in the container, e.g. by placing it in the current working directory.
291-
```
292-
docker run --rm -v $(pwd):/data dbpedia/databus-python-client download https://databus.dbpedia.org/dbpedia-enterprise/live-fusion-snapshots/fusion/2025-08-23/fusion_props=all_subjectns=commons-wikimedia-org_vocab=all.ttl.gz --token vault-token.dat
293-
```
294-
295305

296306
## Module Usage
297307
### Step 1: Create lists of distributions for the dataset

0 commit comments

Comments
 (0)