Skip to content

Commit ad4efa7

Browse files
committed
chore: clean up tasks (#49) and formatting
1 parent 704136a commit ad4efa7

8 files changed

Lines changed: 187 additions & 114 deletions

File tree

README.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ docker run --rm -v $(pwd):/data dbpedia/databus-python-client download $DOWNLOAD
178178
- Enables on-the-fly compression format conversion during download. Supported formats: `bz2`, `gz`, `xz`. Downloaded files will be automatically decompressed and recompressed to the target format. Example: `--convert-to gz` converts all downloaded compressed files to gzip format.
179179
- `--convert-from`
180180
- Optional filter to specify which source compression format should be converted. Use with `--convert-to` to convert only files with a specific compression format. Example: `--convert-to gz --convert-from bz2` converts only `.bz2` files to `.gz`, leaving other formats unchanged.
181+
- `--validate-checksum`
182+
- Validates the checksums of downloaded files against the checksums provided by the Databus. If a checksum does not match, an error is raised and the file is deleted.
181183

182184
**Help and further information on download command:**
183185
```bash
@@ -205,9 +207,9 @@ Options:
205207
databus
206208
--all-versions When downloading artifacts, download all
207209
versions instead of only the latest
208-
--authurl TEXT Keycloak token endpoint URL [default:
209-
https://auth.dbpedia.org/realms/dbpedia/protocol
210-
/openid-connect/token]
210+
--authurl TEXT Keycloak token endpoint URL [default: https://a
211+
uth.dbpedia.org/realms/dbpedia/protocol/openid-
212+
connect/token]
211213
--clientid TEXT Client ID for token exchange [default: vault-
212214
token-exchange]
213215
--convert-to [bz2|gz|xz] Target compression format for on-the-fly
@@ -216,6 +218,7 @@ Options:
216218
--convert-from [bz2|gz|xz] Source compression format to convert from
217219
(optional filter). Only files with this
218220
compression will be converted.
221+
--validate-checksum Validate checksums of downloaded files
219222
--help Show this message and exit.
220223
```
221224
@@ -318,9 +321,15 @@ Options:
318321
--version-id TEXT Target databus version/dataset identifier of the form <h
319322
ttps://databus.dbpedia.org/$ACCOUNT/$GROUP/$ARTIFACT/$VE
320323
RSION> [required]
321-
--title TEXT Dataset title [required]
322-
--abstract TEXT Dataset abstract max 200 chars [required]
323-
--description TEXT Dataset description [required]
324+
--title TEXT Artifact & Version Title: used for BOTH artifact and
325+
version. Keep stable across releases; identifies the
326+
data series. [required]
327+
--abstract TEXT Artifact & Version Abstract: used for BOTH artifact and
328+
version (max 200 chars). Updating it changes both
329+
artifact and version metadata. [required]
330+
--description TEXT Artifact & Version Description: used for BOTH artifact
331+
and version. Supports Markdown. Updating it changes both
332+
artifact and version metadata. [required]
324333
--license TEXT License (see dalicc.net) [required]
325334
--apikey TEXT API key [required]
326335
--metadata PATH Path to metadata JSON file (for metadata mode)

databusclient/__main__.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@
77

88

99
def main():
10-
"""Invoke the CLI application.
10+
"""Invoke the CLI application.
1111
12-
Kept as a named function for easier testing and clarity.
13-
"""
12+
Kept as a named function for easier testing and clarity.
13+
"""
1414

15-
cli.app()
15+
cli.app()
1616

1717

1818
if __name__ == "__main__":
19-
main()
19+
main()

0 commit comments

Comments
 (0)