You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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`.
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
+
161
185
### Deploy command
162
186
```
163
187
databusclient deploy --help
@@ -195,10 +219,10 @@ Options:
195
219
--remote TEXT rclone remote name (e.g., 'my-nextcloud')
196
220
--path TEXT Remote path on Rclone Remote (e.g., 'datasets/mydataset')
@@ -213,11 +237,13 @@ A few more notes for CLI usage:
213
237
* 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`
214
238
215
239
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.
217
245
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.
`file_format` and `compression` fields are optional.
278
+
If omitted, the system attempts to detect them automatically.
250
279
251
280
252
-
#####Mode 3: Upload & Deploy via Rclone
281
+
#### Mode 3: Upload & Deploy via Rclone
253
282
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.**
256
285
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:
257
290
```bash
258
291
databusclient deploy \
259
292
--remote my-nextcloud \
@@ -269,29 +302,6 @@ databusclient deploy \
269
302
```
270
303
271
304
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`.
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
-
295
305
296
306
## Module Usage
297
307
### Step 1: Create lists of distributions for the dataset
0 commit comments