pyjelly 0.3.0__tar.gz → 0.5.0__tar.gz

{pyjelly-0.3.0 → pyjelly-0.5.0}/.github/workflows/ci.yml

@@ -67,15 +67,23 @@ jobs:
       id: install
       run: uv sync
 
-    - name: Install latest Jelly CLI
-      id: install-cli
-      run: ./scripts/download-cli /opt/jelly-cli && echo '/opt' >> $GITHUB_PATH
+    - name: Install jelly-cli
+      uses: jelly-rdf/setup-cli@v1
       if: ${{ !cancelled() && steps.install.conclusion == 'success' && matrix.conformance-tests }}
 
     - name: Run unit tests
-      id: unit-tests
-      run: uv run pytest -svv
-      if: ${{ !cancelled() && steps.install.conclusion == 'success' }}
+      run: uv run pytest -vv
+      if: ${{ !cancelled() && steps.install.conclusion == 'success' && !matrix.conformance-tests }}
+
+    - name: Run unit tests (with conformance tests and coverage)
+      run: uv run pytest -vv --cov --cov-branch --cov-report=xml
+      if: ${{ !cancelled() && steps.install.conclusion == 'success' && matrix.conformance-tests }}
+
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      if: ${{ !cancelled() && steps.install.conclusion == 'success' && matrix.conformance-tests }}
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
 
     - name: Check formatting
       id: formatting

{pyjelly-0.3.0 → pyjelly-0.5.0}/.github/workflows/release.yml

@@ -58,7 +58,7 @@ jobs:
         uses: pypa/gh-action-pypi-publish@release/v1
 
       - name: 'Create a GitHub release'
-        uses: ncipollo/release-action@v1.16.0
+        uses: ncipollo/release-action@v1.18.0
         with:
           prerelease: false
           draft: false

{pyjelly-0.3.0 → pyjelly-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyjelly
-Version: 0.3.0
+Version: 0.5.0
 Summary: Jelly-RDF implementation for Python
 Project-URL: Homepage, https://w3id.org/jelly/pyjelly
 Project-URL: Documentation, https://w3id.org/jelly/pyjelly
@@ -28,13 +28,14 @@ Classifier: Topic :: File Formats
 Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.9
-Requires-Dist: protobuf>=5.29.3
+Requires-Dist: protobuf>=6.30.0
+Requires-Dist: pytest-cov>=6.2.1
 Requires-Dist: typing-extensions>=4.12.2
 Provides-Extra: rdflib
 Requires-Dist: rdflib>=7.1.4; extra == 'rdflib'
 Description-Content-Type: text/markdown
 
-[![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fw3id.org%2Fjelly%2Fpyjelly&label=Documentation)](https://w3id.org/jelly/pyjelly) [![PyPI – Version](https://img.shields.io/pypi/v/pyjelly)](https://pypi.org/project/pyjelly/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyjelly)](https://pypi.org/project/pyjelly/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI status](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml/badge.svg)](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml) [![Discord](https://img.shields.io/discord/1333391881404420179?label=Discord%20chat)](https://discord.gg/A8sN5XwVa5)
+[![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fw3id.org%2Fjelly%2Fpyjelly&label=Documentation)](https://w3id.org/jelly/pyjelly) [![PyPI – Version](https://img.shields.io/pypi/v/pyjelly)](https://pypi.org/project/pyjelly/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyjelly)](https://pypi.org/project/pyjelly/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI status](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml/badge.svg)](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml) [![Code coverage](https://codecov.io/gh/Jelly-RDF/pyjelly/branch/main/graph/badge.svg?token=2D8M2QH6U0)](https://codecov.io/gh/Jelly-RDF/pyjelly) [![Discord](https://img.shields.io/discord/1333391881404420179?label=Discord%20chat)](https://discord.gg/A8sN5XwVa5)
 
 # pyjelly
 
@@ -50,13 +51,13 @@ Description-Content-Type: text/markdown
 
 ## Getting started
 
-To get started with pyjelly, you can install it via pip:
+Install pyjelly from **[PyPI](https://pypi.org/project/pyjelly/)**:
 
 ```bash
 pip install pyjelly[rdflib]
 ```
 
-To write an RDF graph to a Jelly file, you can use the following code:
+To write an RDF graph to a Jelly file:
 
 ```python
 from rdflib import Graph
@@ -66,7 +67,7 @@ g.parse("http://xmlns.com/foaf/spec/index.rdf")
 g.serialize(destination="foaf.jelly", format="jelly")
 ```
 
-To read a Jelly file and convert it to an rdflib Graph, you can use:
+To read a Jelly file and convert it to an rdflib `Graph`:
 
 ```python
 from rdflib import Graph
@@ -75,19 +76,19 @@ g = Graph()
 g.parse("foaf.jelly", format="jelly")
 ```
 
-**See more examples, [API reference](https://w3id.org/jelly/pyjelly/dev/api), and more in the [documentation](https://w3id.org/jelly/pyjelly).**
+**See [our documentation](https://w3id.org/jelly/pyjelly) for [further examples](https://w3id.org/jelly/pyjelly/dev/getting-started/), a full [API reference](https://w3id.org/jelly/pyjelly/dev/api), and more.**
 
 ## Contributing and support
 
 This project is being actively developed – you can stay tuned by [watching this repository](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications#subscription-options).
 
-You can also join the **[Jelly Discord chat](https://discord.gg/A8sN5XwVa5)** to ask questions about pyjelly and to be up-to-date with the development activities.
+Join the **[Jelly Discord chat](https://discord.gg/A8sN5XwVa5)** to ask questions about pyjelly and to be up-to-date with the development activities.
 
 ### Commercial support
 
 **[NeverBlink](https://neverblink.eu)** provides commercial support services for Jelly, including implementing custom features, system integrations, implementations for new frameworks, benchmarking, and more.
 
-## Contributing
+### Contributing
 
 If you'd like to contribute, check out our [contributing guidelines](CONTRIBUTING.md).
 

{pyjelly-0.3.0 → pyjelly-0.5.0}/README.md

@@ -1,4 +1,4 @@
-[![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fw3id.org%2Fjelly%2Fpyjelly&label=Documentation)](https://w3id.org/jelly/pyjelly) [![PyPI – Version](https://img.shields.io/pypi/v/pyjelly)](https://pypi.org/project/pyjelly/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyjelly)](https://pypi.org/project/pyjelly/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI status](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml/badge.svg)](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml) [![Discord](https://img.shields.io/discord/1333391881404420179?label=Discord%20chat)](https://discord.gg/A8sN5XwVa5)
+[![Documentation](https://img.shields.io/website?url=https%3A%2F%2Fw3id.org%2Fjelly%2Fpyjelly&label=Documentation)](https://w3id.org/jelly/pyjelly) [![PyPI – Version](https://img.shields.io/pypi/v/pyjelly)](https://pypi.org/project/pyjelly/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyjelly)](https://pypi.org/project/pyjelly/) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![CI status](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml/badge.svg)](https://github.com/Jelly-RDF/pyjelly/actions/workflows/ci.yml) [![Code coverage](https://codecov.io/gh/Jelly-RDF/pyjelly/branch/main/graph/badge.svg?token=2D8M2QH6U0)](https://codecov.io/gh/Jelly-RDF/pyjelly) [![Discord](https://img.shields.io/discord/1333391881404420179?label=Discord%20chat)](https://discord.gg/A8sN5XwVa5)
 
 # pyjelly
 
@@ -14,13 +14,13 @@
 
 ## Getting started
 
-To get started with pyjelly, you can install it via pip:
+Install pyjelly from **[PyPI](https://pypi.org/project/pyjelly/)**:
 
 ```bash
 pip install pyjelly[rdflib]
 ```
 
-To write an RDF graph to a Jelly file, you can use the following code:
+To write an RDF graph to a Jelly file:
 
 ```python
 from rdflib import Graph
@@ -30,7 +30,7 @@ g.parse("http://xmlns.com/foaf/spec/index.rdf")
 g.serialize(destination="foaf.jelly", format="jelly")
 ```
 
-To read a Jelly file and convert it to an rdflib Graph, you can use:
+To read a Jelly file and convert it to an rdflib `Graph`:
 
 ```python
 from rdflib import Graph
@@ -39,19 +39,19 @@ g = Graph()
 g.parse("foaf.jelly", format="jelly")
 ```
 
-**See more examples, [API reference](https://w3id.org/jelly/pyjelly/dev/api), and more in the [documentation](https://w3id.org/jelly/pyjelly).**
+**See [our documentation](https://w3id.org/jelly/pyjelly) for [further examples](https://w3id.org/jelly/pyjelly/dev/getting-started/), a full [API reference](https://w3id.org/jelly/pyjelly/dev/api), and more.**
 
 ## Contributing and support
 
 This project is being actively developed – you can stay tuned by [watching this repository](https://docs.github.com/en/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications#subscription-options).
 
-You can also join the **[Jelly Discord chat](https://discord.gg/A8sN5XwVa5)** to ask questions about pyjelly and to be up-to-date with the development activities.
+Join the **[Jelly Discord chat](https://discord.gg/A8sN5XwVa5)** to ask questions about pyjelly and to be up-to-date with the development activities.
 
 ### Commercial support
 
 **[NeverBlink](https://neverblink.eu)** provides commercial support services for Jelly, including implementing custom features, system integrations, implementations for new frameworks, benchmarking, and more.
 
-## Contributing
+### Contributing
 
 If you'd like to contribute, check out our [contributing guidelines](CONTRIBUTING.md).
 

pyjelly-0.5.0/codecov.yml

@@ -0,0 +1,4 @@
+ignore:
+  - "docs"
+  - "tests"
+  - "examples"

{pyjelly-0.3.0 → pyjelly-0.5.0}/docs/contributing/index.md

@@ -4,16 +4,33 @@ Hi! This guide explains how to get started with developing pyjelly and contribut
 
 ## Quick start
 
-1. Clone the project with `git clone git@github.com:Jelly-RDF/pyjelly.git`.
+Clone the project: 
 
-2. We use `uv` for package management. If you don't already have it, [install uv](https://github.com/astral-sh/uv).
-    * On Linux this is: `curl -LsSf https://astral.sh/uv/install.sh | sh`
+```shell
+git clone --recursive git@github.com:Jelly-RDF/pyjelly.git
+```
+
+We use `uv` for package management. If you don't already have it, [install uv](https://github.com/astral-sh/uv).
 
-3. Run `uv sync` to install the project.
-    * If you use an IDE, make sure that it uses the Python interpreter from the environment that will be created in the `.venv` directory.
-    * If you get an error about the uv version being incorrect, run `uv self update`
+On Linux this is: 
 
-4. [Activate the environment](https://docs.python.org/3/library/venv.html#how-venvs-work) or use [`uv run` to run commands and code](https://docs.astral.sh/uv/guides/projects/). 
+```shell
+curl -LsSf https://astral.sh/uv/install.sh | sh
+```
+
+Install the project:
+
+```shell
+uv sync
+```
+
+!!! note 
+    
+    If you use an IDE, make sure that it uses the Python interpreter from the environment that will be created in the `.venv` directory.
+
+    If you get an error about the uv version being incorrect, run `uv self update`
+
+[Activate the environment](https://docs.python.org/3/library/venv.html#how-venvs-work) or use [`uv run` to run commands and code](https://docs.astral.sh/uv/guides/projects/). 
 
 ## Giving feedback
 
@@ -27,16 +44,22 @@ If you are proposing a feature:
 
 ## Contributing code
 
-1. Every major pull request should be connected to an issue. If you see a problem, first create an issue.
-    * For minor issues (typos, small fixes) make sure you describe your problem well in the PR.
-2. When opening a pull request:
-    * Use a descriptive title.
-    * Reference the related issue in the description.
-3. Please make sure your code passes all the checks:
-    * Tests (`pytest`)
-    * Type safety (`mypy`)
-    * Formatting and linting (`ruff` or via `pre-commit`)
-    This helps us follow best practices and keep the codebase in shape.
+If you've found a major issue (not just a typo) or have a feature request, please [open an issue](https://github.com/Jelly-RDF/pyjelly/issues/new/choose) first. This helps us keep track of what needs to be done and allows others to contribute as well.
+
+**When opening a pull request:**
+
+- Use a descriptive title.
+- Clearly describe what the pull request does and why it is needed.
+- Reference the related issue in the description.
+
+The CI will check if your code passes all checks. You can run these checks locally:
+
+- Tests: `uv run pytest`
+- Type safety: `uv run mypy .`
+- Linter: `uv run ruff check --fix`
+- Formatter: `uv run ruff format`
+
+This helps us follow best practices and keep the codebase in shape.
 
 ## Contributing documentation
 

{pyjelly-0.3.0 → pyjelly-0.5.0}/docs/env.py

@@ -90,7 +90,7 @@ def define_env(env):
     @env.macro
     def git_link(file: str):
         tag = git_tag()
-        return f"https://github.com/Jelly-RDF/jelly-python/blob/{tag}/{file}"
+        return f"https://github.com/Jelly-RDF/pyjelly/blob/{tag}/{file}"
 
     @env.macro
     def proto_version():

pyjelly-0.5.0/docs/examples/neo4j_integration/01_rdflib_neo4j_parse_grouped.py

@@ -0,0 +1,49 @@
+import urllib.request
+from neo4j import GraphDatabase
+from rdflib import Graph
+from rdflib_neo4j import Neo4jStoreConfig, Neo4jStore, HANDLE_VOCAB_URI_STRATEGY
+
+# Example file from the Riverbench
+example_file, _ = urllib.request.urlretrieve("https://w3id.org/riverbench/v/dev.jelly")
+
+# Please introduce your credentials
+aura_db_uri = "aura_db_uri"
+aura_db_username = "neo4j"
+aura_db_pwd = "aura_db_pwd"
+
+# Prepare the authentication data to the Aura database
+auth_data = {
+    "uri": aura_db_uri,
+    "database": "neo4j",
+    "user": aura_db_username,
+    "pwd": aura_db_pwd,
+}
+
+# Prepare the configuration for neo4j store object
+config = Neo4jStoreConfig(
+    auth_data=auth_data,
+    handle_vocab_uri_strategy=HANDLE_VOCAB_URI_STRATEGY.IGNORE,
+    batching=True,
+)
+
+# Make a graph with Neo4jStore object
+neo4j_sink = Graph(store=Neo4jStore(config=config))
+
+# Parse the file into the AuraDB
+neo4j_sink.parse(example_file, format="jelly")
+
+# Close the stream
+neo4j_sink.close(True)
+
+# Cypher query to check loaded data
+with GraphDatabase.driver(
+    aura_db_uri, auth=(aura_db_username, aura_db_pwd)
+).session() as session:
+    count = session.run("MATCH ()-[r]->() RETURN count(r) AS c").single()["c"]
+    print(f"Loaded {count} triples")
+    for r in session.run(
+        "MATCH (s)-[r]->(o) RETURN s.uri AS s, type(r) AS p, coalesce(o.uri,o.name) AS o LIMIT 5"
+    ):
+        print(r["s"], f"-[{r['p']}]->", r["o"])
+
+print("All done.")

pyjelly-0.5.0/docs/examples/networkx_integration/01_parse_calculate_visualize.py

@@ -0,0 +1,44 @@
+import urllib.request
+from rdflib import Graph
+from rdflib.extras.external_graph_libs import rdflib_to_networkx_graph
+import networkx as nx
+import matplotlib.pyplot as plt
+
+# Example Jelly file
+example_file, _ = urllib.request.urlretrieve("https://w3id.org/riverbench/v/dev.jelly")
+
+# Parse RDF from the Jelly format
+rdf_g = Graph()
+rdf_g.parse(example_file, format="jelly")
+
+# Convert to a NetworkX graph from RDFLib
+nx_g = rdflib_to_networkx_graph(rdf_g)
+
+# Example calculation, get the number of connected components in a graph
+num_components = nx.number_connected_components(nx_g)
+
+# Example calculation, get top 5 objects with highest degrees, something simple in NetworkX
+top5 = sorted(nx_g.degree, key=lambda x: x[1], reverse=True)[:5]
+
+# Example calculation, shortest path between two nodes
+# Provide two example nodes in a graph
+source, target = list(nx_g.nodes)[0], list(nx_g.nodes)[-1]
+path = nx.shortest_path(nx_g, source=source, target=target)
+
+# Draw and display the graph
+pos = nx.spring_layout(nx_g)
+plt.figure(figsize=(10, 10))
+
+# Introduce your own settings for display
+nx.draw_networkx(
+    nx_g, pos, with_labels=True, font_size=4, node_size=300, linewidths=0.6
+)
+plt.axis("off")
+plt.show()
+
+print(f"Connected components: {num_components}")
+print("Top 5 nodes sorted by degree:")
+for node, deg in top5:
+    print(f"{node}: {deg}")
+print(f"Shortest path from {source} to {target}: {' -> '.join(path)}")
+print("All done.")

pyjelly-0.5.0/docs/examples/networkx_integration/02_serialize.py

@@ -0,0 +1,28 @@
+import networkx as nx
+from rdflib import Graph, URIRef, Namespace
+from rdflib.namespace import RDF
+
+# An example NetworkX graph
+nx_g = nx.Graph()
+nx_g.add_node("http://example.org/A")
+nx_g.add_node("http://example.org/B")
+nx_g.add_edge("http://example.org/A", "http://example.org/B")
+
+# We define RDFLib graph for further conversion
+rdf_g = Graph()
+
+# Example namespace
+ex = Namespace("http://example.org/ns#")
+
+# Add triples through node information in NetworkX graph
+for node_uri, data in nx_g.nodes(data=True):
+    subj = URIRef(node_uri)
+    rdf_g.add((subj, RDF.type, ex.Node))
+
+# Add triples through edge information in NetworkX graph
+for u, v, attr in nx_g.edges(data=True):
+    rdf_g.add((URIRef(u), ex.connectedTo, URIRef(v)))
+
+# Serialize graph into a .jelly file
+rdf_g.serialize(destination="networkx_graph.jelly", format="jelly")
+print("All done.")

pyjelly-0.5.0/docs/examples/rdflib/04_parse_grouped.py

@@ -0,0 +1,20 @@
+import gzip
+import urllib.request
+
+from pyjelly.integrations.rdflib.parse import parse_jelly_grouped
+
+# Dataset: Katrina weather measurements (10k graphs)
+# Documentation: https://w3id.org/riverbench/datasets/lod-katrina/dev
+url = "https://w3id.org/riverbench/datasets/lod-katrina/dev/files/jelly_10K.jelly.gz"
+
+# Load, uncompress .gz file, and pass to Jelly parser, all in a streaming manner
+with (
+    urllib.request.urlopen(url) as response,
+    gzip.open(response) as jelly_stream,
+):
+    graphs = parse_jelly_grouped(jelly_stream)
+    for i, graph in enumerate(graphs):
+        print(f"Graph {i} in the stream has {len(graph)} triples")
+        # Limit to 50 graphs for demonstration -- the rest will not be parsed
+        if i >= 50:
+            break

pyjelly-0.5.0/docs/examples/rdflib/05_parse_flat.py

@@ -0,0 +1,29 @@
+import gzip
+import urllib.request
+
+from pyjelly.integrations.rdflib.parse import parse_jelly_flat, Triple
+from rdflib import URIRef
+
+# Dataset: OpenStreetMap data for Denmark (first 10k objects)
+# Documentation: https://w3id.org/riverbench/datasets/osm2rdf-denmark/dev
+url = (
+    "https://w3id.org/riverbench/datasets/osm2rdf-denmark/dev/files/jelly_10K.jelly.gz"
+)
+
+# We are looking for city names in the dataset
+predicate_to_look_for = URIRef("https://www.openstreetmap.org/wiki/Key:addr:city")
+city_names = set()
+
+with (
+    urllib.request.urlopen(url) as response,
+    gzip.open(response) as jelly_stream,
+):
+    for event in parse_jelly_flat(jelly_stream):
+        if isinstance(event, Triple):  # we are only interested in triples
+            if event.p == predicate_to_look_for:
+                city_names.add(event.o)
+
+print(f"Found {len(city_names)} unique city names in the dataset.")
+print("10 random city names:")
+for city in list(city_names)[:10]:
+    print(f"- {city}")

pyjelly-0.5.0/docs/examples/rdflib/06_serialize_grouped.py

@@ -0,0 +1,22 @@
+from pyjelly.integrations.rdflib.serialize import grouped_stream_to_file
+
+from rdflib import Graph, Literal, Namespace
+import random
+
+
+def generate_sample_graphs():
+    ex = Namespace("http://example.org/")
+    for _ in range(10):
+        g = Graph()
+        g.add((ex.sensor, ex.temperature, Literal(random.random())))
+        g.add((ex.sensor, ex.humidity, Literal(random.random())))
+        yield g
+
+
+output_file_name = "output.jelly"
+
+print(f"Streaming graphs into {output_file_name}…")
+sample_graphs = generate_sample_graphs()
+with open(output_file_name, "wb") as out_file:
+    grouped_stream_to_file(sample_graphs, out_file)
+print("All done.")

pyjelly-0.5.0/docs/examples/rdflib/07_serialize_flat.py

@@ -0,0 +1,19 @@
+from pyjelly.integrations.rdflib.serialize import flat_stream_to_file
+from rdflib import Literal, Namespace
+import random
+
+
+# example generator with triples statements
+def generate_sample_triples():
+    ex = Namespace("http://example.org/")
+    for _ in range(10):
+        yield (ex.sensor, ex.temperature, Literal(random.random()))
+
+
+output_file_name = "flat_output.jelly"
+
+print(f"Streaming triples into {output_file_name}…")
+sample_triples = generate_sample_triples()
+with open(output_file_name, "wb") as out_file:
+    flat_stream_to_file(sample_triples, out_file)
+print("All done.")

pyjelly-0.5.0/docs/external-integration.md

@@ -0,0 +1,69 @@
+# Pyjelly integration with external libraries
+
+This section describes how to integrate useful third‑party libraries that utilize RDFLib.  
+In order to proceed with the content of the document, one should be acquainted with the [getting-started.md](getting-started.md) file.
+
+## Neo4j - rdflib
+
+The Neo4j RDFLib library is a Python plugin that lets you use RDFLib’s API to parse RDF triples directly in a Neo4j graph database.  
+Because Neo4j integrates well with the baseline RDFLib objects, which is also true for pyjelly, both libraries can be easily combined.  
+
+In further steps we will exemplify the integration, however first, (in our pyjelly environment) we should install rdflib-neo4j:  
+```
+pip install rdflib-neo4j
+```
+
+For more information, one should visit the following references found on the rdflib-neo4j original sources, which formed the base of
+the following document:  
+    - [github.com/neo4j-labs/rdflib-neo4j](https://github.com/neo4j-labs/rdflib-neo4j)  
+    - [neo4j.com/labs/rdflib-neo4j/](https://neo4j.com/labs/rdflib-neo4j/)  
+
+### Configure Your AuraDB Connection
+
+Before running the example code, make sure to provide your own credentials to the AuraDB instance listed below:
+```
+AURA_DB_URI
+AURA_DB_USERNAME
+AURA_DB_PWD
+```
+
+### Parsing data into neo4j from a jelly file
+
+To parse data into the neo4j database from `.jelly` file use the following example:
+
+{{ code_example('neo4j_integration/01_rdflib_neo4j_parse_grouped.py') }}
+
+which parses the data from `.jelly` file into the user's AuraDB database.
+
+## NetworkX
+
+NetworkX is a Python package for the creation, manipulation, and analysis of the structure, dynamics, and functions of networks represented as graphs.
+Due to its seamless integration with RDFlib and PyJelly via its conversion utilities, these libraries can be easily combined for graph analysis and transformation tasks.
+
+To successfully go through the use cases, one should primarily install the following libraries:
+```
+pip install networkx==3.2.1 matplotlib==3.9.4
+```
+
+To get more information about the NetworkX itself, see the package's documentation and other useful utilities:  
+    - [networkx.org/documentation/stable/auto_examples](https://networkx.org/documentation/stable/auto_examples/index.html)  
+    - [rdflib.readthedocs.io/en/7.1.0/_modules/rdflib/extras/external_graph_libs.html](https://rdflib.readthedocs.io/en/7.1.0/_modules/rdflib/extras/external_graph_libs.html)  
+    - [github.com/networkx/networkx](https://github.com/networkx/networkx)  
+
+In the following sub-sections, we will describe a few useful and baseline use cases for performing integration between the modules.
+
+### Parse graph into NetworkX object, visualize it, calculate useful graph-based characteristics
+
+To load data into a NetworkX object, starting from a `.jelly` file, and (optionally) calculate some practical graph characteristics, one can look into the example:
+
+{{ code_example('networkx_integration/01_parse_calculate_visualize.py') }}
+
+which loads the data from RDFLib graph into equivalent NetworkX graph, performs computation of useful graph theory metrics and visualizes the graph.
+
+### Transform and serialize NetworkX graph
+
+To transform a NetworkX graph into RDFLib graph and perform its serialization into the `.jelly` format, look into the example:
+
+{{ code_example('networkx_integration/02_serialize.py') }}
+
+Which converts an example-defined NetworkX graph into RDFLib graph and performs its serialization.

pyjelly-0.5.0/docs/getting-started.md

@@ -0,0 +1,91 @@
+# Getting started
+
+This guide shows how to install pyjelly and prepare your environment for use with RDFLib.
+
+## Installation (with RDFLib)
+
+Install pyjelly from PyPI:
+
+```
+pip install pyjelly[rdflib]
+```
+
+pyjelly requires **Python 3.9** or newer and works on all major platforms (Linux, macOS, Windows).
+
+
+## Usage with RDFLib
+
+Once installed, pyjelly integrates with RDFLib automatically. You can immediately serialize and parse `.jelly` files using the standard RDFLib API.
+
+### Serializing a graph
+
+To serialize a graph to the Jelly format:
+
+{{ code_example('rdflib/01_serialize.py') }}
+
+This creates a [delimited Jelly stream]({{ proto_link("user-guide/#delimited-vs-non-delimited-jelly") }}) using default options.
+
+### Parsing a graph
+
+To load RDF data from a `.jelly` file:
+
+{{ code_example('rdflib/02_parse.py') }}
+
+RDFLib will reconstruct the graph from the Jelly file.
+
+### Parsing a stream of graphs
+
+You can process a Jelly stream as a stream of graphs. A Jelly file consists of "frames" (batches of statements) – we can load each frame as a separate RDFLib graph.
+
+In this example, we use a [dataset of weather measurements](https://w3id.org/riverbench/datasets/lod-katrina/dev), which is an RDF graph stream. We count the number of triples in each graph:
+
+{{ code_example('rdflib/04_parse_grouped.py') }}
+
+Because `parse_jelly_grouped` returns a generator, each iteration receives **one** graph, keeping memory usage bounded to the current frame. So, large datasets and live streams can be processed efficiently.
+
+### Parsing a stream of triples
+
+You can also process a Jelly stream as a flat stream of triples.
+
+In this more complex example, we look through a fragment of Denmark's OpenStreetMap to find all city names:
+
+{{ code_example('rdflib/05_parse_flat.py') }}
+
+`parse_jelly_flat` returns a generator of stream events (i.e., statements parsed). This allows you to efficiently process the file triple-by-triple and build custom aggregations from the stream.
+
+### Serializing a stream of graphs
+
+If you have a generator object containing graphs, you can easily serialize it into the Jelly format, like in the following example: 
+
+{{ code_example('rdflib/06_serialize_grouped.py')}}
+
+This method allows for transmitting logically grouped data, preserving their original division.
+For more precise control over frame serialization you can use [lower-level API](api.md)
+
+### Serializing a stream of statements
+
+If you have a generator object containing statements, you can easily serialize it into the Jelly format, like in the following example: 
+
+{{ code_example('rdflib/07_serialize_flat.py')}}
+
+The flat method transmits the data as a continuous sequence of individual statements (i.e., triples or quads), keeping the simplicity and order of the data.
+For more precise control over frame serialization you can use [lower-level API](api.md)
+
+### Serializing a stream of graphs
+
+If you have a generator object containing graphs, you can easily serialize it into the Jelly format, like in the following example: 
+
+{{ code_example('rdflib/06_serialize_grouped.py')}}
+
+This method allows for transmitting logically grouped data, preserving their original division.
+For more precise control over frame serialization you can use [lower-level API](api.md)
+
+### File extension support
+
+You can generally omit the `format="jelly"` parameter if the file ends in `.jelly` – RDFLib will auto-detect the format:
+
+{{ code_example('rdflib/03_parse_autodetect.py') }}
+
+!!! warning 
+
+    Unfortunately, the way this is implemented in RDFLib is a bit wonky, so it will only work if you explicitly import `pyjelly.integrations.rdflib`, or you used `format="jelly"` in the `serialize()` or `parse()` call before.