pyjelly 0.2.1__tar.gz → 0.2.3__tar.gz

{pyjelly-0.2.1 → pyjelly-0.2.3}/.github/workflows/release.yml

@@ -24,6 +24,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       id-token: write
+      contents: write
 
     steps:
       - uses: actions/checkout@v4
@@ -56,6 +57,16 @@ jobs:
       - name: Publish package distributions
         uses: pypa/gh-action-pypi-publish@release/v1
 
+      - name: 'Create a GitHub release'
+        uses: ncipollo/release-action@v1.16.0
+        with:
+          prerelease: false
+          draft: false
+          makeLatest: true
+          tag: "${{ github.ref_name }}"
+          name: "${{ github.ref_name }}"
+          generateReleaseNotes: true
+
   release-docs:
     runs-on: ubuntu-latest
     steps:

{pyjelly-0.2.1 → pyjelly-0.2.3}/.gitignore

@@ -64,3 +64,6 @@ dmypy.json
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+
+# Temporary files for testing
+temp/

{pyjelly-0.2.1 → pyjelly-0.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyjelly
-Version: 0.2.1
+Version: 0.2.3
 Summary: Jelly-RDF implementation for Python
 Project-URL: Homepage, https://w3id.org/jelly/pyjelly
 Project-URL: Documentation, https://w3id.org/jelly/pyjelly

pyjelly-0.2.3/SECURITY.md

@@ -0,0 +1,7 @@
+# Security policy
+
+## Reporting a vulnerability
+
+If you find a security issue or vulnerability, please **do not** open a public issue. Instead, **[use the dedicated vulnerability reporting page](https://github.com/Jelly-RDF/pyjelly/security/advisories/new)**.
+
+We will get back to you as soon as possible.

{pyjelly-0.2.1 → pyjelly-0.2.3}/docs/contributing/index.md

@@ -66,3 +66,16 @@ uv run mkdocs serve
 - [Material for MkDocs reference](https://squidfunk.github.io/mkdocs-material/reference/)
 - [MkDocs documentation](https://www.mkdocs.org/user-guide/writing-your-docs/)
 - [Macro plugin documentation](https://mkdocs-macros-plugin.readthedocs.io/en/latest/)
+
+## Making releases
+
+1. Make sure you are on the `main` branch and that it is up-to-date: `git checkout main && git pull`.
+2. Checkout a new branch.
+3. Update the version in `pyproject.toml` with either:
+    - `uv version X.Y.Z`
+    - `uv version --bump major|minor|patch`
+4. Commit the changes, push the branch, and open a pull request.
+5. Once the pull request is merged, go back to the `main` branch: `git checkout main && git pull`.
+6. Create a new tag for the release. For example, for version 1.2.3: `git tag v1.2.3`. **The tag must start with `v`!**
+7. Push the tag to GitHub: `git push origin v1.2.3`.
+8. The release will be automatically built and published to PyPI.

{pyjelly-0.2.1 → pyjelly-0.2.3}/docs/env.py

@@ -106,6 +106,32 @@ def define_env(env):
         version = proto_version()
         return f"https://w3id.org/jelly/{version}/{page}"
 
+    @env.macro
+    def code_example(file_name):
+        with open(f"examples/{file_name}", "r") as f:
+            code = f.read()
+        return f"""
+```python
+{code}
+```
+"""
+
+    @env.macro
+    def code_example_box(file_name):
+        name = f"examples/{file_name}"
+        with open(name, "r") as f:
+            code = f.read()
+        code = code.replace("\n", "\n    ")
+        return f"""
+??? example "Example: {file_name} (click to expand)"
+
+    **[:octicons-code-24: Source code on GitHub]({git_link(name)})**
+
+    ```python title="{file_name}" linenums="1"
+    {code}
+    ```
+"""
+
     def transform_nav_item(item):
         if list(item.values())[0] == "https://w3id.org/jelly/":
             return {list(item.keys())[0]: proto_link("")}

pyjelly-0.2.3/docs/examples/README.md

@@ -0,0 +1,3 @@
+Code examples for using pyjelly in practice.
+
+The examples will be executed in alphabetical order, so you can number them accordingly.

pyjelly-0.2.3/docs/examples/rdflib/01_serialize.py

@@ -0,0 +1,5 @@
+from rdflib import Graph
+
+g = Graph()
+g.parse("http://xmlns.com/foaf/spec/index.rdf")
+g.serialize(destination="foaf.jelly", format="jelly")

pyjelly-0.2.3/docs/examples/rdflib/02_parse.py

@@ -0,0 +1,8 @@
+from rdflib import Graph
+
+g = Graph()
+g.parse("foaf.jelly", format="jelly")
+
+print("Parsed triples:")
+for s, p, o in g:
+    print(f"{s} {p} {o}")

pyjelly-0.2.3/docs/examples/rdflib/03_parse_autodetect.py

@@ -0,0 +1,5 @@
+from rdflib import Graph
+import pyjelly.integrations.rdflib
+
+g = Graph()
+g.parse("foaf.jelly")

{pyjelly-0.2.1 → pyjelly-0.2.3}/docs/getting-started.md

@@ -21,13 +21,7 @@ Once installed, pyjelly integrates with RDFLib automatically. You can immediatel
 
 To serialize a graph to the Jelly format:
 
-```python
-from rdflib import Graph
-
-g = Graph()
-g.parse("http://xmlns.com/foaf/spec/index.rdf")
-g.serialize(destination="foaf.jelly", format="jelly")
-```
+{{ code_example('rdflib/01_serialize.py') }}
 
 This creates a [delimited Jelly stream]({{ proto_link("user-guide/#delimited-vs-non-delimited-jelly") }}) using default options.
 
@@ -35,23 +29,16 @@ This creates a [delimited Jelly stream]({{ proto_link("user-guide/#delimited-vs-
 
 To load RDF data from a `.jelly` file:
 
-```python
-from rdflib import Graph
-
-g = Graph()
-g.parse("foaf.jelly")
-
-print("Parsed triples:")
-for s, p, o in g:
-    print(f"{s} {p} {o}")
-```
+{{ code_example('rdflib/02_parse.py') }}
 
 RDFLib will reconstruct the graph from the serialized Jelly stream.
 
 ### File extension support
 
-You can omit the `format="jelly"` parameter if the file ends in `.jelly` – RDFLib will auto-detect the format using pyjelly's entry point:
+You can generally omit the `format="jelly"` parameter if the file ends in `.jelly` – RDFLib will auto-detect the format:
 
-```python
-g.parse("foaf.jelly")  # format inferred automatically
-```
+{{ 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.

{pyjelly-0.2.1 → pyjelly-0.2.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "pyjelly"
-version = "0.2.1"
+version = "0.2.3"
 readme = "README.md"
 description = "Jelly-RDF implementation for Python"
 authors = [
@@ -101,7 +101,7 @@ extra-standard-library = ["typing_extensions"]
 
 [tool.pytest.ini_options]
 pythonpath = "."
-addopts = ["--import-mode=importlib", "--doctest-modules"]
+addopts = ["--import-mode=importlib", "--doctest-modules", "--ignore-glob=**examples"]
 
 [tool.ruff]
 extend-exclude = ["*{_pb2,_pb2_grpc}.{py,pyi}"]
@@ -111,6 +111,9 @@ packages = ["pyjelly"]
 
 [tool.ruff.lint]
 extend-per-file-ignores = { "tests/unit_tests/**" = ["PLR2004"] }
+exclude = [
+    "**examples/**",
+]
 select = ["ALL"]
 ignore = [
     # Description: Dynamically typed expressions (typing.Any) are disallowed

pyjelly-0.2.3/tests/integration_tests/test_rdflib/test_examples.py

@@ -0,0 +1,14 @@
+import pathlib
+import runpy
+
+import pytest
+
+scripts = list(pathlib.Path(__file__, "..", "examples").resolve().glob("*.py"))
+scripts.sort()
+
+
+@pytest.mark.parametrize("script", scripts, ids=lambda p: p.name)
+def test_rdflib_examples(script: pathlib.Path, monkeypatch: pytest.MonkeyPatch) -> None:
+    # Run the examples in a temporary directory to avoid polluting the repository
+    monkeypatch.chdir(pathlib.Path(__file__, "..", "temp").resolve())
+    runpy.run_path(str(script))

{pyjelly-0.2.1 → pyjelly-0.2.3}/uv.lock

@@ -1294,7 +1294,7 @@ wheels = [
 
 [[package]]
 name = "pyjelly"
-version = "0.2.1"
+version = "0.2.3"
 source = { editable = "." }
 dependencies = [
     { name = "protobuf" },