tripper 0.3.0__tar.gz → 0.3.4__tar.gz

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/cd_release.yml

@@ -6,9 +6,9 @@ on:
     - published
 
 jobs:
-  publish-package-and-docs:
+  build:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/cd_release.yml@v2.8.2
     if: github.repository == 'EMMC-ASBL/tripper' && startsWith(github.ref, 'refs/tags/v')
     with:
       # General
@@ -23,7 +23,9 @@ jobs:
       python_version_build: "3.9"
       build_libs: "flit"
       build_cmd: "flit build"
-      publish_on_pypi: true
+      build_dir: "dist"
+      publish_on_pypi: false
+      upload_distribution: true
 
       # Build & publish documentation
       update_docs: true
@@ -32,5 +34,25 @@ jobs:
       changelog_exclude_labels: "skip_changelog,duplicate,question,invalid,wontfix"
       docs_framework: mkdocs
     secrets:
-      PyPI_token: ${{ secrets.PYPI_TOKEN }}
       PAT: ${{ secrets.RELEASE_PAT }}
+
+  publish:
+    name: Publish on PyPI
+    needs: build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: release
+      url: https://pypi.org/project/tripper/
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download built distritbution
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+
+      - name: Publish on PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/ci_automerge_dependency_prs.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   update-dependencies-branch:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/ci_automerge_prs.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL' && ( ( startsWith(github.event.pull_request.head.ref, 'dependabot/') && github.actor == 'dependabot[bot]' ) || ( github.event.pull_request.head.ref == 'ci/update-pyproject' && github.actor == 'TEAM4-0' ) )
     secrets:
       PAT: ${{ secrets.RELEASE_PAT }}

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/ci_cd_updated_main.yml

@@ -7,7 +7,7 @@ on:
 jobs:
   update-deps-branch-and-docs:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/ci_cd_updated_default_branch.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       # General

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/ci_check_dependencies.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   check-dependencies:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/ci_check_pyproject_dependencies.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       git_username: "TEAM 4.0[bot]"

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/ci_tests.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   basic-tests:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/ci_tests.yml@v2.8.2
     with:
       ## General settings:
       install_extras: "[dev]"
@@ -36,12 +36,14 @@ jobs:
       #  https://pyup.io/vulnerabilities/CVE-2021-34141/44717/
       # 70612: Jinja2 vulnerability. Only used as subdependency for mkdocs++ in tripper.
       #  https://data.safetycli.com/v/70612/97c/
+      #  https://data.safetycli.com/v/72715/97c/   # update to mkdocs>=9.5.32
       safety_options: |
         --ignore=48547
         --ignore=44715
         --ignore=44716
         --ignore=44717
         --ignore=70612
+        --ignore=72715
 
       ## Build package
       run_build_package: true
@@ -84,6 +86,9 @@ jobs:
         pip install -U setuptools wheel flit
         pip install -e .[testing]
 
+    - name: List installed packages
+      run: pip freeze
+
     - name: Test with pytest
       run: pytest -vvv --cov-report=xml --doctest-modules
 

{tripper-0.3.0 → tripper-0.3.4}/.github/workflows/ci_update_dependencies.yml

@@ -9,7 +9,7 @@ on:
 jobs:
   create-collected-pr:
     name: External
-    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.7.4
+    uses: SINTEF/ci-cd/.github/workflows/ci_update_dependencies.yml@v2.8.2
     if: github.repository_owner == 'EMMC-ASBL'
     with:
       git_username: "TEAM 4.0[bot]"

{tripper-0.3.0 → tripper-0.3.4}/.pre-commit-config.yaml

@@ -19,7 +19,7 @@ ci:
 # hooks
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
     - id: end-of-file-fixer
       exclude: ^.*\.(svg)$
@@ -41,19 +41,20 @@ repos:
       - --skip-gitignore
 
   - repo: https://github.com/psf/black
-    rev: 24.4.2
+    rev: 24.10.0
     hooks:
     - id: black
+      args: [--line-length=79]
 
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.9
+    rev: 1.7.10
     hooks:
     - id: bandit
       args: ["-r"]
       files: ^tripper/.*$
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.10.0
+    rev: v1.11.2
     hooks:
     - id: mypy
       exclude: ^tests/.*$
@@ -62,7 +63,7 @@ repos:
         - "pydantic"
 
   - repo: https://github.com/SINTEF/ci-cd
-    rev: v2.7.4
+    rev: v2.8.2
     hooks:
     - id: docs-api-reference
       args:

{tripper-0.3.0 → tripper-0.3.4}/CHANGELOG.md

@@ -1,5 +1,62 @@
 # Changelog
 
+## [v0.3.4](https://github.com/EMMC-ASBL/tripper/tree/v0.3.4) (2024-10-15)
+
+[Full Changelog](https://github.com/EMMC-ASBL/tripper/compare/v0.3.3...v0.3.4)
+
+**Merged pull requests:**
+
+- Allowing backends to indicate whether they prefer the sparql interface [\#255](https://github.com/EMMC-ASBL/tripper/pull/255) ([jesper-friis](https://github.com/jesper-friis))
+- \[pre-commit.ci\] pre-commit autoupdate [\#254](https://github.com/EMMC-ASBL/tripper/pull/254) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+- Update n3 format for string with quotes. [\#253](https://github.com/EMMC-ASBL/tripper/pull/253) ([pintr](https://github.com/pintr))
+- Added option to Triplestore.value\(\) to return a generator over all matching values [\#252](https://github.com/EMMC-ASBL/tripper/pull/252) ([jesper-friis](https://github.com/jesper-friis))
+- Ignore safety vulnerabeility 72715 [\#251](https://github.com/EMMC-ASBL/tripper/pull/251) ([jesper-friis](https://github.com/jesper-friis))
+- Fix empty prefix [\#250](https://github.com/EMMC-ASBL/tripper/pull/250) ([jesper-friis](https://github.com/jesper-friis))
+- \[pre-commit.ci\] pre-commit autoupdate [\#249](https://github.com/EMMC-ASBL/tripper/pull/249) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+- Backend info to triplestore instance [\#248](https://github.com/EMMC-ASBL/tripper/pull/248) ([jesper-friis](https://github.com/jesper-friis))
+- Added argument `ignore_unrecognised` to tripper.convert\(\) [\#247](https://github.com/EMMC-ASBL/tripper/pull/247) ([jesper-friis](https://github.com/jesper-friis))
+- \[pre-commit.ci\] pre-commit autoupdate [\#244](https://github.com/EMMC-ASBL/tripper/pull/244) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+
+## [v0.3.3](https://github.com/EMMC-ASBL/tripper/tree/v0.3.3) (2024-08-26)
+
+[Full Changelog](https://github.com/EMMC-ASBL/tripper/compare/v0.3.2...v0.3.3)
+
+**Implemented enhancements:**
+
+- Use Trusted Publishers for PyPI [\#242](https://github.com/EMMC-ASBL/tripper/issues/242)
+
+**Closed issues:**
+
+- Add instructions of how to release a new version [\#47](https://github.com/EMMC-ASBL/tripper/issues/47)
+- Update Python API references in README [\#22](https://github.com/EMMC-ASBL/tripper/issues/22)
+
+**Merged pull requests:**
+
+- Use Trusted Publishers on PyPI [\#243](https://github.com/EMMC-ASBL/tripper/pull/243) ([CasperWA](https://github.com/CasperWA))
+
+## [v0.3.2](https://github.com/EMMC-ASBL/tripper/tree/v0.3.2) (2024-08-19)
+
+[Full Changelog](https://github.com/EMMC-ASBL/tripper/compare/v0.3.1...v0.3.2)
+
+**Merged pull requests:**
+
+- Minor fix for documentation layout  [\#238](https://github.com/EMMC-ASBL/tripper/pull/238) ([jesper-friis](https://github.com/jesper-friis))
+- Updated documentation navigation [\#237](https://github.com/EMMC-ASBL/tripper/pull/237) ([jesper-friis](https://github.com/jesper-friis))
+- Updated cd\_release workflow [\#236](https://github.com/EMMC-ASBL/tripper/pull/236) ([jesper-friis](https://github.com/jesper-friis))
+
+## [v0.3.1](https://github.com/EMMC-ASBL/tripper/tree/v0.3.1) (2024-08-16)
+
+[Full Changelog](https://github.com/EMMC-ASBL/tripper/compare/v0.3.0...v0.3.1)
+
+**Merged pull requests:**
+
+- Avoid that tripper.Namespace crashes if the cache directory cannot be accessed [\#235](https://github.com/EMMC-ASBL/tripper/pull/235) ([jesper-friis](https://github.com/jesper-friis))
+- \[pre-commit.ci\] pre-commit autoupdate [\#232](https://github.com/EMMC-ASBL/tripper/pull/232) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+- \[pre-commit.ci\] pre-commit autoupdate [\#231](https://github.com/EMMC-ASBL/tripper/pull/231) ([pre-commit-ci[bot]](https://github.com/apps/pre-commit-ci))
+- Cleaned up backend tests [\#230](https://github.com/EMMC-ASBL/tripper/pull/230) ([jesper-friis](https://github.com/jesper-friis))
+- Added a fix for parsing rdflib literals. [\#229](https://github.com/EMMC-ASBL/tripper/pull/229) ([jesper-friis](https://github.com/jesper-friis))
+- Add better and more convenient support for rdf:JSON datatype [\#228](https://github.com/EMMC-ASBL/tripper/pull/228) ([jesper-friis](https://github.com/jesper-friis))
+
 ## [v0.3.0](https://github.com/EMMC-ASBL/tripper/tree/v0.3.0) (2024-06-24)
 
 [Full Changelog](https://github.com/EMMC-ASBL/tripper/compare/v0.2.16...v0.3.0)

{tripper-0.3.0 → tripper-0.3.4}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.1
 Name: tripper
-Version: 0.3.0
+Version: 0.3.4
 Summary: A triplestore wrapper for Python.
 Keywords: triplestore,ontology,RDF
 Author-email: SINTEF <TEAM4.0@sintef.no>
-Requires-Python: ~=3.7
+Requires-Python: >=3.7
 Description-Content-Type: text/markdown
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: License :: OSI Approved :: MIT License
@@ -18,42 +18,47 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Environment :: Plugins
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
-Requires-Dist: typing-extensions ~=4.7; python_version<'3.8'
+Requires-Dist: typing-extensions>=4.7.0,<4.7.1; python_version<'3.8'
 Requires-Dist: pint>=0.16.1,<0.24
-Requires-Dist: mike ~=2.1 ; extra == "dev"
-Requires-Dist: mkdocs ~=1.5 ; extra == "dev"
-Requires-Dist: mkdocs-awesome-pages-plugin ~=2.9 ; extra == "dev"
-Requires-Dist: mkdocs-material >=9.2.8 ; extra == "dev"
-Requires-Dist: mkdocstrings[python-legacy] ~=0.22.0 ; extra == "dev"
-Requires-Dist: pre-commit ~=2.21 ; extra == "dev"
-Requires-Dist: pylint ~=2.13 ; extra == "dev"
-Requires-Dist: pytest ~=7.4 ; extra == "dev"
-Requires-Dist: pytest-cov ~=4.1 ; extra == "dev"
-Requires-Dist: EMMOntoPy ~=0.7 ; extra == "dev"
-Requires-Dist: rdflib ~=6.3 ; extra == "dev"
-Requires-Dist: SPARQLWrapper ~=2.0 ; extra == "dev"
-Requires-Dist: DLite-Python >=0.5.1,<0.5.17 ; extra == "dev"
-Requires-Dist: mike ~=2.1 ; extra == "docs"
-Requires-Dist: mkdocs ~=1.5 ; extra == "docs"
-Requires-Dist: mkdocs-awesome-pages-plugin ~=2.9 ; extra == "docs"
-Requires-Dist: mkdocs-material >=9.2.8 ; extra == "docs"
-Requires-Dist: mkdocstrings[python-legacy] ~=0.22.0 ; extra == "docs"
-Requires-Dist: EMMOntoPy ~=0.7 ; extra == "docs"
-Requires-Dist: rdflib ~=6.3 ; extra == "docs"
-Requires-Dist: SPARQLWrapper ~=2.0 ; extra == "docs"
-Requires-Dist: DLite-Python >=0.5.1,<0.5.17 ; extra == "docs"
-Requires-Dist: pre-commit ~=2.21 ; extra == "pre-commit"
-Requires-Dist: pylint ~=2.13 ; extra == "pre-commit"
-Requires-Dist: pytest ~=7.4 ; extra == "testing"
-Requires-Dist: pytest-cov ~=4.1 ; extra == "testing"
-Requires-Dist: EMMOntoPy ~=0.7 ; extra == "testing"
-Requires-Dist: rdflib ~=6.3 ; extra == "testing"
-Requires-Dist: SPARQLWrapper ~=2.0 ; extra == "testing"
-Requires-Dist: DLite-Python >=0.5.1,<0.5.17 ; extra == "testing"
-Requires-Dist: graphviz ~= 0.20 ; extra == "testing"
-Requires-Dist: pint>=0.16.1,<0.23 ; extra == "testing"
-Requires-Dist: pytest ~=7.4 ; extra == "testing-core"
-Requires-Dist: pytest-cov ~=4.1 ; extra == "testing-core"
+Requires-Dist: pre-commit==2.21.0 ; extra == "dev"
+Requires-Dist: pylint==2.15.5 ; extra == "dev"
+Requires-Dist: pytest==7.4.4 ; extra == "dev"
+Requires-Dist: pytest-cov==4.1.0 ; extra == "dev"
+Requires-Dist: EMMOntoPy>=0.5.0,<0.7.1 ; extra == "dev"
+Requires-Dist: rdflib>=6.3.0,<7.0.0 ; extra == "dev"
+Requires-Dist: SPARQLWrapper>=2.0.0,<2.0.1 ; extra == "dev"
+Requires-Dist: DLite-Python>=0.5.1,<0.5.17 ; extra == "dev"
+Requires-Dist: graphviz>=0.20.1,<0.20.2 ; extra == "dev"
+Requires-Dist: mike==2.1.2 ; extra == "dev"
+Requires-Dist: mkdocs==1.5.3 ; extra == "dev"
+Requires-Dist: mkdocs-autorefs==0.4.1 ; extra == "dev"
+Requires-Dist: mkdocs-awesome-pages-plugin==2.9.2 ; extra == "dev"
+Requires-Dist: mkdocs-material==9.5.17 ; extra == "dev"
+Requires-Dist: mkdocstrings==0.22.0 ; extra == "dev"
+Requires-Dist: mkdocstrings-python-legacy==0.2.3 ; extra == "dev"
+Requires-Dist: EMMOntoPy>=0.5.0,<0.7.1 ; extra == "docs"
+Requires-Dist: rdflib>=6.3.0,<7.0.0 ; extra == "docs"
+Requires-Dist: SPARQLWrapper>=2.0.0,<2.0.1 ; extra == "docs"
+Requires-Dist: DLite-Python>=0.5.1,<0.5.17 ; extra == "docs"
+Requires-Dist: mike==2.1.2 ; extra == "docs"
+Requires-Dist: mkdocs==1.5.3 ; extra == "docs"
+Requires-Dist: mkdocs-autorefs==0.4.1 ; extra == "docs"
+Requires-Dist: mkdocs-awesome-pages-plugin==2.9.2 ; extra == "docs"
+Requires-Dist: mkdocs-material==9.5.17 ; extra == "docs"
+Requires-Dist: mkdocstrings==0.22.0 ; extra == "docs"
+Requires-Dist: mkdocstrings-python-legacy==0.2.3 ; extra == "docs"
+Requires-Dist: pre-commit==4.0.1 ; extra == "pre-commit"
+Requires-Dist: pylint==2.15.5 ; extra == "pre-commit"
+Requires-Dist: pint>=0.16.1,<0.24 ; extra == "testing"
+Requires-Dist: pytest==7.4.4 ; extra == "testing"
+Requires-Dist: pytest-cov==4.1.0 ; extra == "testing"
+Requires-Dist: EMMOntoPy>=0.5.0,<0.7.1 ; extra == "testing"
+Requires-Dist: rdflib>=6.3.0,<7.0.0 ; extra == "testing"
+Requires-Dist: SPARQLWrapper>=2.0.0,<2.0.1 ; extra == "testing"
+Requires-Dist: DLite-Python>=0.5.1,<0.5.17 ; extra == "testing"
+Requires-Dist: graphviz>=0.20.1,<0.20.2 ; extra == "testing"
+Requires-Dist: pytest==7.4.4 ; extra == "testing-core"
+Requires-Dist: pytest-cov==4.1.0 ; extra == "testing-core"
 Project-URL: Changelog, https://github.com/EMMC-ASBL/tripper/blob/master/CHANGELOG.md
 Project-URL: Documentation, https://EMMC-ASBL.github.io/tripper
 Project-URL: Home, https://github.com/EMMC-ASBL/tripper
@@ -77,6 +82,12 @@ Tripper
 [![DOI](https://zenodo.org/badge/547162834.svg)](https://zenodo.org/badge/latestdoi/547162834)
 
 
+Getting started
+---------------
+* [Tutorial]
+* [Discovery of custom backends]
+* [Reference manual]
+
 
 Basic concepts
 --------------
@@ -107,13 +118,6 @@ The submodules `mappings` and `convert` provide additional functionality beyond
 - **tripper.convert**: convert between RDF and other data representations.
 
 
-Documentation
--------------
-* Getting started: See the [tutorial](docs/tutorial.md)
-* [Discovery of custom backends](docs/backend_discovery.md)
-* [Reference manual]
-
-
 Available backends
 ------------------
 The following backends are currently available, either in Tripper or other packages.
@@ -153,7 +157,7 @@ pip install rdflib pint
 
 License and copyright
 ---------------------
-All files in this repository are licensed under the [MIT license](LICENSE).
+All files in this repository are licensed under the [MIT license].
 If not stated otherwise in the top of the files, they have copyright &copy; 2022
 SINTEF.
 
@@ -172,11 +176,15 @@ We gratefully acknowledge the following projects for supporting the development
 
 
 
+[Tutorial]: https://emmc-asbl.github.io/tripper/latest/tutorial/
+[Discovery of custom backends]: https://emmc-asbl.github.io/tripper/latest/backend_discovery/
+[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
+[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues/
+[MIT license]: https://emmc-asbl.github.io/tripper/latest/LICENSE/
 [tripper]: https://emmc-asbl.github.io/tripper
 [rdflib]: https://rdflib.readthedocs.io/en/stable/
 [PyPI]: https://pypi.org/project/tripper
 [PyBackTrip]: https://github.com/EMMC-ASBL/PyBackTrip/
-[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
 [Literal]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Literal
 [Namespace]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Namespace
 [Triplestore]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Triplestore

{tripper-0.3.0 → tripper-0.3.4}/README.md

@@ -9,6 +9,12 @@ Tripper
 [![DOI](https://zenodo.org/badge/547162834.svg)](https://zenodo.org/badge/latestdoi/547162834)
 
 
+Getting started
+---------------
+* [Tutorial]
+* [Discovery of custom backends]
+* [Reference manual]
+
 
 Basic concepts
 --------------
@@ -39,13 +45,6 @@ The submodules `mappings` and `convert` provide additional functionality beyond
 - **tripper.convert**: convert between RDF and other data representations.
 
 
-Documentation
--------------
-* Getting started: See the [tutorial](docs/tutorial.md)
-* [Discovery of custom backends](docs/backend_discovery.md)
-* [Reference manual]
-
-
 Available backends
 ------------------
 The following backends are currently available, either in Tripper or other packages.
@@ -85,7 +84,7 @@ pip install rdflib pint
 
 License and copyright
 ---------------------
-All files in this repository are licensed under the [MIT license](LICENSE).
+All files in this repository are licensed under the [MIT license].
 If not stated otherwise in the top of the files, they have copyright © 2022
 SINTEF.
 
@@ -104,11 +103,15 @@ We gratefully acknowledge the following projects for supporting the development
 
 
 
+[Tutorial]: https://emmc-asbl.github.io/tripper/latest/tutorial/
+[Discovery of custom backends]: https://emmc-asbl.github.io/tripper/latest/backend_discovery/
+[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
+[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues/
+[MIT license]: https://emmc-asbl.github.io/tripper/latest/LICENSE/
 [tripper]: https://emmc-asbl.github.io/tripper
 [rdflib]: https://rdflib.readthedocs.io/en/stable/
 [PyPI]: https://pypi.org/project/tripper
 [PyBackTrip]: https://github.com/EMMC-ASBL/PyBackTrip/
-[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
 [Literal]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Literal
 [Namespace]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Namespace
 [Triplestore]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Triplestore

tripper-0.3.4/docs/developers.md

@@ -0,0 +1,28 @@
+# For developers
+
+## Adding new backends
+
+See [interface.py], which defines the interface of a backend and may serve as a template for creating new backends.
+
+
+
+## Creating new release
+
+To create a new release, it is good to have a release summary.
+
+To add this, create a milestone that matches the new version and tag, e.g., `v1.0.8`.
+
+Then create a new issue, adding it to the milestone and add the `release-summary` label.
+
+For the issue description, write the actual release summary.
+This will be included as part of the changelog as well as the release notes on GitHub.
+
+Then, go to [create a new GitHub releases](https://github.com/EMMC-ASBL/tripper/releases/new) and select the tag that matches the milestone (creating a new one).
+Add again the tag as the release title (optionally write something else that defines this release as a title).
+
+Finally, press the "Publish release" button and ensure the release workflow succeeds (check [the release workflow](https://github.com/EMMC-ASBL/tripper/actions/workflows/cd_release.yml)).
+
+
+
+
+[interface.py]: https://github.com/EMMC-ASBL/tripper/blob/master/tripper/interface.py

{tripper-0.3.0 → tripper-0.3.4}/docs/index.md

@@ -9,6 +9,12 @@ Tripper
 [![DOI](https://zenodo.org/badge/547162834.svg)](https://zenodo.org/badge/latestdoi/547162834)
 
 
+Getting started
+---------------
+* [Tutorial]
+* [Discovery of custom backends]
+* [Reference manual]
+
 
 Basic concepts
 --------------
@@ -39,13 +45,6 @@ The submodules `mappings` and `convert` provide additional functionality beyond
 - **tripper.convert**: convert between RDF and other data representations.
 
 
-Documentation
--------------
-* Getting started: See the [tutorial](tutorial.md)
-* [Discovery of custom backends](backend_discovery.md)
-* [Reference manual]
-
-
 Available backends
 ------------------
 The following backends are currently available, either in Tripper or other packages.
@@ -85,7 +84,7 @@ pip install rdflib pint
 
 License and copyright
 ---------------------
-All files in this repository are licensed under the [MIT license](LICENSE.md).
+All files in this repository are licensed under the [MIT license].
 If not stated otherwise in the top of the files, they have copyright © 2022
 SINTEF.
 
@@ -104,11 +103,15 @@ We gratefully acknowledge the following projects for supporting the development
 
 
 
+[Tutorial]: https://emmc-asbl.github.io/tripper/latest/tutorial/
+[Discovery of custom backends]: https://emmc-asbl.github.io/tripper/latest/backend_discovery/
+[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
+[Known issues]: https://emmc-asbl.github.io/tripper/latest/known-issues/
+[MIT license]: https://emmc-asbl.github.io/tripper/latest/LICENSE/
 [tripper]: https://emmc-asbl.github.io/tripper
 [rdflib]: https://rdflib.readthedocs.io/en/stable/
 [PyPI]: https://pypi.org/project/tripper
 [PyBackTrip]: https://github.com/EMMC-ASBL/PyBackTrip/
-[Reference manual]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/
 [Literal]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Literal
 [Namespace]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Namespace
 [Triplestore]: https://emmc-asbl.github.io/tripper/latest/api_reference/triplestore/#tripper.triplestore.Triplestore

tripper-0.3.4/docs/known-issues.md

@@ -0,0 +1,10 @@
+Known issues
+============
+
+  * If you use the rdflib backend and don't have write permissions to
+    the cache directory (which e.g. can happen if you run Python in
+    docker as a non-root user), you may get a `urllib.error.HTTPError`
+    error when accessing an online rdf resource.
+
+    Setting the environment variable `XDG_CACHE_HOME` to a directory
+    that you have write access to will solve the problem.

{tripper-0.3.0 → tripper-0.3.4}/mkdocs.yml

@@ -80,9 +80,12 @@ plugins:
 nav:
   - Home: index.md
   - Tutorial: tutorial.md
-  - License: LICENSE.md
-  - Changelog: CHANGELOG.md
+  - Backend discovery: backend_discovery.md
   - ... | api_reference/**
+  - Known issues: known-issues.md
+  - For developers: developers.md
+  - Changelog: CHANGELOG.md
+  - License: LICENSE.md
 
 watch:
   - tripper