GSoC2026 : Docs Refactoring (Issue #86) by DhanashreePetare · Pull Request #87 · dbpedia/databus-python-client

DhanashreePetare · 2026-08-26T18:29:45Z

Description

Restructures project documentation :

README.md kept slim: Quickstart, DBpedia (Docker commands removed, Docker mentioned once overall), a new GSoC 2026 section, Development & Contributing, plus short CLI/module overviews linking out to detailed docs.
Detailed CLI documentation (download/deploy/delete/manifest/workflow) moved to doc/cli-usage.md.
Python module usage documentation moved to doc/module-usage.md.
Examples moved to doc/examples/, including all workflow example files.
Added doc/README.md as a navigation index for the documentation folder.

Related Issues

Closes #86

Type of change

Housekeeping

…oc/ folder for CLI/module/examples usage

coderabbitai · 2026-08-26T18:29:55Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 658c4cf0-1a04-4190-ba88-0061e24a6d1e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

DhanashreePetare · 2026-08-26T18:35:01Z

The proposal link attached is correct but not showing the document, I will update that with a drive link of proposal.

Integer-Ctrl

What about https://github.com/DhanashreePetare/databus-python-client/blob/gsoc-2026/run_all_conversion_tests.py?

Integer-Ctrl · 2026-08-27T11:16:37Z

cli-workflow & cli-manifest removed but not moved to cli-usage or any other file

Integer-Ctrl · 2026-08-27T12:15:48Z

-    - [Download Live Fusion KG Dump (BUSL 1.1, registration needed)](#download-live-fusion-kg-dump-busl-11-registration-needed)
-    - [Download Enriched Knowledge Graphs (BUSL 1.1, registration needed)](#download-enriched-knowledge-graphs-busl-11-registration-needed)
-    - [Download DBpedia Wikipedia Knowledge Graphs (CC-BY-SA, no registration needed)](#download-dbpedia-wikipedia-knowledge-graphs-cc-by-sa-no-registration-needed)
-    - [Download DBpedia Wikidata Knowledge Graphs (CC-BY-SA, no registration needed)](#download-dbpedia-wikidata-knowledge-graphs-cc-by-sa-no-registration-needed)


Could you leave the licence information in place? Might not be necessary in the title (toc links), but in the corresponding section

Integer-Ctrl · 2026-08-27T12:24:14Z

Replace lines with: databusclient [delete|deploy|download|manifest|workflow] --help

Integer-Ctrl · 2026-08-27T12:34:38Z

-```
-
-Only existing data already stored in the manifest is read — no new files are downloaded or written, and no network access happens.
+The manifest options record operation parameters, file outcomes, checksums, byte sizes, and execution summaries in JSON-LD. Manifests can also be replayed or summarized. See the [manifest docs](doc/cli-usage.md#manifest).


doc/cli-usage.md#manifest mentioned above, missing

Integer-Ctrl · 2026-08-27T12:35:16Z

-```bash
-databusclient workflow run examples/workflows/download-deploy.yml
-```
+The `workflow` command runs declarative download, deploy, and delete pipelines from YAML files, with step chaining and per-step error handling. See the [workflow docs](doc/cli-usage.md#workflow).


doc/cli-usage.md#workflow mentioned above, missing

Integer-Ctrl · 2026-08-27T12:50:15Z

+# Output:
+Usage: databusclient download [OPTIONS] DATABUSURIS...


Same regarding output

Integer-Ctrl · 2026-08-27T12:50:33Z

+# Output:
+Usage: databusclient deploy [OPTIONS] [DISTRIBUTIONS]...


Same regarding output

Integer-Ctrl · 2026-08-27T12:50:47Z

+# Output:
+Usage: databusclient delete [OPTIONS] DATABUSURIS...


Same regarding output

Integer-Ctrl · 2026-08-27T12:57:43Z

+- `--convert-to`
+  - 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.
+- `--convert-from`
+  - 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.


Refactored --convert-to & --convert-from, but the actual CLI exposes --compression. The moved docs
reintroduced stale option name

Integer-Ctrl · 2026-08-27T12:58:36Z

+databusclient download https://databus.dbpedia.org/dbpedia/mappings/mappingbased-literals/2022.12.01 --convert-to gz
+
+# Convert only bz2 files to xz format, leaving other compressions unchanged
+databusclient download https://databus.dbpedia.org/dbpedia/mappings/mappingbased-literals --convert-to xz --convert-from bz2
+
+# Download a collection and unify all files to bz2 format
+databusclient download https://databus.dbpedia.org/dbpedia/collections/dbpedia-snapshot-2022-12 --convert-to bz2


Mentioned above, stale option

DhanashreePetare added 3 commits August 26, 2026 16:16

docs: restructure documentation per issue dbpedia#86 - slim README, d…

f3afead

…oc/ folder for CLI/module/examples usage

docs:refactoring

66e01b0

docs: remove trailing whitespace

55f0a34

DhanashreePetare requested a review from Integer-Ctrl August 26, 2026 18:31

Integer-Ctrl reviewed Aug 27, 2026

View reviewed changes

DhanashreePetare added 3 commits August 28, 2026 19:22

docs: restore manifest and workflow CLI documentation

ac26696

docs: align CLI guide with current commands

0ed74f2

docs: fix CLI help examples and compression wording

ec641d5

		# Output:
		Usage: databusclient download [OPTIONS] DATABUSURIS...

		# Output:
		Usage: databusclient deploy [OPTIONS] [DISTRIBUTIONS]...

		# Output:
		Usage: databusclient delete [OPTIONS] DATABUSURIS...

Uh oh!

Conversation

DhanashreePetare commented Aug 26, 2026

Description

Related Issues

Type of change

Uh oh!

coderabbitai Bot commented Aug 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

DhanashreePetare commented Aug 26, 2026

Uh oh!

Integer-Ctrl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

coderabbitai Bot commented Aug 26, 2026 •

edited

Loading