pyjelly 0.1.0__tar.gz → 0.2.1__tar.gz

pyjelly-0.2.1/.gitattributes

@@ -0,0 +1,3 @@
+# Mark Jelly files as binary
+*.jelly binary
+*.jellyp binary

pyjelly-0.1.0/.github/workflows/quality.yml → pyjelly-0.2.1/.github/workflows/ci.yml

@@ -1,15 +1,15 @@
-name: quality-gate
+name: ci
 
 on:
   push:
-    branches:
-    -  main
+    branches: [main]
+    tags: ['v*']
   pull_request:
 
 concurrency:
-  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
-  cancel-in-progress: true
-    
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 env:
   FORCE_COLOR: 1
   PY_COLORS: 1
@@ -21,9 +21,9 @@ defaults:
     shell: bash
 
 jobs:
-  quality-gate:
+  check:
     if: ${{ github.actor != 'dependabot[bot]' && !cancelled() }}
-    name: ${{ matrix.runs-test-cases && '(test cases) ' || '' }}${{ matrix.version }} ${{matrix.platform}}
+    name: ${{ matrix.conformance-tests && '(conformance) ' || '' }}${{ matrix.version }} ${{matrix.platform}}
     runs-on: ${{ matrix.platform }}
 
     env:
@@ -33,14 +33,9 @@ jobs:
       fail-fast: false
       # https://blog.jaraco.com/efficient-use-of-ci-resources/
       matrix:
-        runs-test-cases:
-        - false
-        version:
-        - '3.9'
-        - '3.13'
-        platform:
-        - ubuntu-latest
-        - macos-latest
+        conformance-tests: [false]
+        version: ['3.9', '3.13']
+        platform: [ubuntu-latest, macos-latest]
         include:
         - version: '3.10'
           platform: ubuntu-latest
@@ -50,9 +45,10 @@ jobs:
           platform: ubuntu-latest
         - version: '3.13'
           platform: ubuntu-latest
-          runs-test-cases: true
-        - version: '3.14'
-          platform: ubuntu-latest
+          conformance-tests: true
+        # rdflib appears to be broken on 3.14
+        # - version: '3.14'
+        #   platform: ubuntu-latest
         - version: pypy3.10
           platform: ubuntu-latest  
         - version: pypy3.11
@@ -74,7 +70,7 @@ jobs:
     - name: Install latest Jelly CLI
       id: install-cli
       run: ./scripts/download-cli /opt/jelly-cli && echo '/opt' >> $GITHUB_PATH
-      if: ${{ !cancelled() && steps.install.conclusion == 'success' && matrix.runs-test-cases }}
+      if: ${{ !cancelled() && steps.install.conclusion == 'success' && matrix.conformance-tests }}
 
     - name: Run unit tests
       id: unit-tests

pyjelly-0.2.1/.github/workflows/release.yml

@@ -0,0 +1,88 @@
+name: release
+
+permissions:
+  contents: write
+  pull-requests: write
+
+on:
+  push:
+    branches: [main]
+    tags: ['v*']
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  UV_LOCKED: 1
+  UV_NO_SYNC: 1
+
+jobs:
+  release:
+    if: ${{ github.ref_type == 'tag' }}
+    name: Release to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          submodules: true
+          persist-credentials: false
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+    
+      - name: Validate tag
+        id: validate-tag
+        run: |
+          set -Eeuxo pipefail
+
+          project_version=v$(uv version --short)
+          tag=${GITHUB_REF#refs/tags/}
+
+          [[ "$tag" == "$project_version" ]] || {
+            echo "Tag $tag does not match project version $project_version"
+            exit 1
+          }
+
+      - name: Build package distributions
+        id: build
+        run: uv build --out-dir dist
+
+      - name: Publish package distributions
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  release-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+  
+      - name: Deploy site
+        run: |
+          set -Eeuxo pipefail
+          export TAG='${{ github.ref_name }}'
+          uv sync --group docs
+          git fetch origin gh-pages --depth=1
+
+          git config user.name github-actions[bot]
+          git config user.email github-actions[bot]@users.noreply.github.com
+
+          if [[ $TAG == v* ]]
+          then
+            V_MAJOR=`echo ${TAG#v} | awk -F '.' '{print $1}'`
+            V_MINOR=`echo ${TAG#v} | awk -F '.' '{print $2}'`
+            uv run mike deploy --push --alias-type=redirect --update-aliases "${V_MAJOR}.${V_MINOR}.x" stable "${TAG#v}"
+          else
+            uv run mike deploy --push --alias-type=redirect --title "Development version" --update-aliases dev latest
+          fi

pyjelly-0.2.1/CONTRIBUTING.md

@@ -0,0 +1 @@
+**Please see the [contribution guide on the pyjelly website](https://w3id.org/jelly/pyjelly/dev/contributing/).** Thanks!

pyjelly-0.2.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: pyjelly
+Version: 0.2.1
+Summary: Jelly-RDF implementation for Python
+Project-URL: Homepage, https://w3id.org/jelly/pyjelly
+Project-URL: Documentation, https://w3id.org/jelly/pyjelly
+Project-URL: Repository, https://github.com/Jelly-RDF/pyjelly
+Project-URL: Issues, https://github.com/Jelly-RDF/pyjelly/issues
+Project-URL: Changelog, https://github.com/Jelly-RDF/pyjelly/releases
+Author-email: "NeverBlink et al." <contact@neverblink.eu>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: Jelly,Knowledge graph,RDF,Serialization format
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Environment :: Plugins
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+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: 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)
+
+# pyjelly
+
+**pyjelly** is a Python implementation of [Jelly](http://w3id.org/jelly), a high-performance binary serialization format and streaming protocol for RDF knowledge graphs.
+
+**Documentation, usage guide and more: https://w3id.org/jelly/pyjelly**
+
+## Features
+
+- **Fast reading and writing** of RDF knowledge graphs in the [Jelly format](http://w3id.org/jelly)
+- **Seamless integration with [rdflib](https://rdflib.readthedocs.io/)**
+- **Stream processing support** for large datasets or streams of many RDF graphs/datasets
+
+## Getting started
+
+To get started with pyjelly, you can install it via pip:
+
+```bash
+pip install pyjelly[rdflib]
+```
+
+To write an RDF graph to a Jelly file, you can use the following code:
+
+```python
+from rdflib import Graph
+
+g = Graph()
+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:
+
+```python
+from rdflib import Graph
+
+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).**
+
+## 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.
+
+### 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
+
+If you'd like to contribute, check out our [contributing guidelines](CONTRIBUTING.md).
+
+## License
+
+The pyjelly library is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+
+----
+
+The development of the Jelly protocol, its implementations, and supporting tooling was co-funded by the European Union. **[More details](https://w3id.org/jelly/dev/licensing/projects)**.

pyjelly-0.2.1/README.md

@@ -0,0 +1,64 @@
+[![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)
+
+# pyjelly
+
+**pyjelly** is a Python implementation of [Jelly](http://w3id.org/jelly), a high-performance binary serialization format and streaming protocol for RDF knowledge graphs.
+
+**Documentation, usage guide and more: https://w3id.org/jelly/pyjelly**
+
+## Features
+
+- **Fast reading and writing** of RDF knowledge graphs in the [Jelly format](http://w3id.org/jelly)
+- **Seamless integration with [rdflib](https://rdflib.readthedocs.io/)**
+- **Stream processing support** for large datasets or streams of many RDF graphs/datasets
+
+## Getting started
+
+To get started with pyjelly, you can install it via pip:
+
+```bash
+pip install pyjelly[rdflib]
+```
+
+To write an RDF graph to a Jelly file, you can use the following code:
+
+```python
+from rdflib import Graph
+
+g = Graph()
+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:
+
+```python
+from rdflib import Graph
+
+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).**
+
+## 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.
+
+### 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
+
+If you'd like to contribute, check out our [contributing guidelines](CONTRIBUTING.md).
+
+## License
+
+The pyjelly library is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
+
+----
+
+The development of the Jelly protocol, its implementations, and supporting tooling was co-funded by the European Union. **[More details](https://w3id.org/jelly/dev/licensing/projects)**.

pyjelly-0.2.1/docs/contributing/index.md

@@ -0,0 +1,68 @@
+# Contributing to pyjelly
+
+Hi! This guide explains how to get started with developing pyjelly and contributing to it.
+
+## Quick start
+
+1. Clone the project with `git clone git@github.com:Jelly-RDF/pyjelly.git`.
+
+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`
+
+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`
+
+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/). 
+
+## Giving feedback
+
+The best way to send feedback is to file an issue at [https://github.com/Jelly-RDF/pyjelly/issues](https://github.com/Jelly-RDF/pyjelly/issues)
+
+If you are proposing a feature:
+
+1. Explain how it would work.
+2. Keep the scope as narrow as possible, to make it easier to implement.
+3. Contributions are always welcome! Consider if you can help with implementing the 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.
+
+## Contributing documentation
+
+The documentation is written in Markdown and built using [MkDocs](https://www.mkdocs.org/), using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
+
+To edit a documentation page, simply click the :material-file-edit-outline: button in the top-right of the page.
+
+It will take you to GitHub, where you can edit the Markdown file and submit a pull request. You can also clone [the repository](https://github.com/Jelly-RDF/pyjelly) and edit the files locally. The source files are in the `docs` directory.
+
+### Previewing documentation locally
+
+Install dependencies for docs:
+
+```shell
+uv sync --group docs
+```
+
+Then, start a local docs server:
+
+```shell
+uv run mkdocs serve
+```
+
+### Further reading
+
+- [More information on editing Jelly docs]({{ proto_link("contributing/#editing-documentation") }})
+- [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/)

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

@@ -2,12 +2,12 @@
 
 This guide shows how to install pyjelly and prepare your environment for use with RDFLib.
 
-## Installation
+## Installation (with RDFLib)
 
 Install pyjelly from PyPI:
 
 ```
-pip install pyjelly
+pip install pyjelly[rdflib]
 ```
 
 pyjelly requires **Python 3.9** or newer and works on all major platforms (Linux, macOS, Windows).
@@ -23,22 +23,10 @@ To serialize a graph to the Jelly format:
 
 ```python
 from rdflib import Graph
-from pyjelly.serialize.streams import Stream
-from pyjelly.options import StreamOptions, StreamTypes
-from pyjelly import jelly
 
 g = Graph()
 g.parse("http://xmlns.com/foaf/spec/index.rdf")
-
-options = StreamOptions(
-    stream_types=StreamTypes(
-        physical_type=jelly.PHYSICAL_STREAM_TYPE_TRIPLES,
-        logical_type=jelly.LOGICAL_STREAM_TYPE_FLAT_TRIPLES,
-    )
-)
-stream = Stream.from_options(options)
-
-g.serialize(destination="foaf.jelly", format="jelly", stream=stream)
+g.serialize(destination="foaf.jelly", format="jelly")
 ```
 
 This creates a [delimited Jelly stream]({{ proto_link("user-guide/#delimited-vs-non-delimited-jelly") }}) using default options.

pyjelly-0.2.1/docs/index.md

@@ -0,0 +1,34 @@
+# 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)
+
+**pyjelly** is a Python implementation of [Jelly]({{ proto_link("") }}), a high-performance binary serialization format and streaming protocol for RDF knowledge graphs. It works great with [rdflib](getting-started.md).
+
+## Features
+
+- **Fast reading and writing** of RDF knowledge graphs in the [Jelly format](http://w3id.org/jelly)
+- **Seamless integration with [rdflib](https://rdflib.readthedocs.io/)**
+- **Stream processing support** for large datasets or streams of many RDF graphs/datasets
+
+## Documentation
+
+- **[Getting started](getting-started.md)**
+- **[Overview and supported features](overview.md)**
+- **[API reference](api.md)**
+- **[Contributing](contributing/index.md)** – how to report issues, contribute code, and request features
+
+## Commercial and community support
+
+**[NeverBlink](https://neverblink.eu)** provides commercial support services for Jelly, including implementing custom features, system integrations, implementations for new frameworks, benchmarking, and more.
+
+Community support is available on the **[Jelly Discord chat](https://discord.gg/A8sN5XwVa5)**.
+
+## License
+
+The pyjelly library is licensed under the [Apache 2.0 license](https://github.com/Jelly-RDF/pyjelly/blob/{{ git_tag() }}/LICENSE).
+
+----
+
+The development of the Jelly protocol, its implementations, and supporting tooling was co-funded by the European Union. **[More details]({{ proto_link( 'licensing/projects' ) }})**.
+
+![European Funds for Smart Economy, Republic of Poland, Co-funded by the European Union](assets/featured/feng_rp_eu.png)

{pyjelly-0.1.0 → pyjelly-0.2.1}/docs/overview.md

@@ -1,6 +1,6 @@
-## What is Jelly and what is pyjelly?
+## What is Jelly and pyjelly?
 
-[Jelly]({{ proto_link() }}) is a serialization format and streaming protocol for RDF knowledge graphs. It enables fast, compact, and flexible transmission of RDF data with Protobuf, supporting both flat and structured streams of triples, quads, graphs, and datasets. Jelly is designed to work well in both batch and real-time settings, including use over files, sockets, or stream processing systems like Kafka or gRPC.
+[Jelly]({{ proto_link() }}) is a high-performance serialization format and streaming protocol for RDF knowledge graphs. It enables fast, compact, and flexible transmission of RDF data with Protobuf, supporting both flat and structured streams of triples, quads, graphs, and datasets. Jelly is designed to work well in both batch and real-time settings, including use over files, sockets, or stream processing systems like Kafka or gRPC.
 
 **pyjelly** is a Python implementation of the Jelly protocol. It provides:
 

{pyjelly-0.1.0 → pyjelly-0.2.1}/mkdocs.yml

@@ -112,6 +112,9 @@ extra:
     - icon: fontawesome/brands/github
       link: https://github.com/Jelly-RDF/pyjelly
       name: pyjelly on GitHub
+    - icon: fontawesome/brands/discord
+      link: https://discord.gg/A8sN5XwVa5
+      name: Community Discord server
 
 nav:
   - Home: "index.md"
@@ -121,4 +124,5 @@ nav:
   - Contributing:
       - "contributing/index.md"
       - Code of conduct: "contributing/code_of_conduct.md"
+  - Changelog: "https://github.com/Jelly-RDF/pyjelly/releases"
   - Back to main Jelly docs ↩: "https://w3id.org/jelly/"