diff --git a/docs/index.md b/docs/index.md index f5e2c93ea..f37fd1381 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,5 @@ +![RDFLib logo](_static/RDFlib.png) + # RDFLib RDFLib is a pure Python package for working with [RDF](http://www.w3.org/RDF/). It contains: diff --git a/docs/upgrade7to8.md b/docs/upgrade7to8.md new file mode 100644 index 000000000..ecc9aa525 --- /dev/null +++ b/docs/upgrade7to8.md @@ -0,0 +1,9 @@ +# Upgrading from version 7 to 8 + +!!! warning "In Development" + This page is in development and will only be completed with the release of RDFLib v8. + +## Python version + +RDFLib 7 requires Python 3.9 or later. + diff --git a/examples/custom_eval.py b/examples/custom_eval.py index fc9649ff0..4d6c6bbae 100644 --- a/examples/custom_eval.py +++ b/examples/custom_eval.py @@ -6,16 +6,7 @@ asking for `rdf:type` triples. Here the custom eval function is added manually, normally you would use -setuptools and entry_points to do it: -i.e. in your setup.py:: - -```python -entry_points = { - 'rdf.plugins.sparqleval': [ - 'myfunc = mypackage:MyFunction', - ], -} -``` +entry points to do it. See the [Plugins Usage Documentation](/plugins/). """ from pathlib import Path diff --git a/mkdocs.yml b/mkdocs.yml index 2aa212c2c..ec321cfed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -29,6 +29,7 @@ nav: - Changes: - Changelog: changelog.md + - Upgrading v7 to 8: upgrade7to8.md - Upgrading v6 to 7: upgrade6to7.md - Upgrading v5 to 6: upgrade5to6.md - Upgrading v4 to 5: upgrade4to5.md @@ -43,6 +44,7 @@ nav: - Container: apidocs/rdflib.container.md - Collection: apidocs/rdflib.collection.md - Paths: apidocs/rdflib.paths.md + - Plugin: apidocs/rdflib.plugin.md - Util: apidocs/rdflib.util.md - Plugins: - Parsers: apidocs/rdflib.plugins.parsers.md @@ -68,7 +70,7 @@ theme: # Choose color: https://squidfunk.github.io/mkdocs-material/setup/changing-the-colors/#primary-color palette: - media: "(prefers-color-scheme: light)" - primary: indigo + primary: blue grey scheme: default toggle: icon: material/weather-night diff --git a/rdflib/plugin.py b/rdflib/plugin.py index c4cae87c8..9b1b8ce25 100644 --- a/rdflib/plugin.py +++ b/rdflib/plugin.py @@ -1,26 +1,9 @@ -"""Plugin support for rdf. - -There are a number of plugin points for rdf: parser, serializer, +"""There are a number of plugin points for rdf: parser, serializer, store, query processor, and query result. Plugins can be registered -either through setuptools entry_points or by calling +either automatically through entry points or by calling rdf.plugin.register directly. -If you have a package that uses a setuptools based `setup.py` you can add the -following to your setup: - -```python -entry_points = { - 'rdf.plugins.parser': [ - 'nt = rdf.plugins.parsers.ntriples:NTParser', - ], - 'rdf.plugins.serializer': [ - 'nt = rdf.plugins.serializers.NTSerializer:NTSerializer', - ], - } -``` - -See the [setuptools dynamic discovery of services and plugins](http://peak.telecommunity.com/DevCenter/setuptools#dynamic-discovery-of-services-and-plugins) -for moreinformation. +For more details, see the [Plugins Usage Documentation](/plugins/). """ from __future__ import annotations diff --git a/rdflib/plugins/__init__.py b/rdflib/plugins/__init__.py index 4622bb0a1..90c50d5d0 100644 --- a/rdflib/plugins/__init__.py +++ b/rdflib/plugins/__init__.py @@ -1,7 +1,5 @@ """ -Default plugins for rdflib. - -This is a namespace package and contains the default plugins for -rdflib. +Default plugins for RDFLib. +This is a namespace package and contains the default plugins for RDFLib. """ diff --git a/rdflib/plugins/parsers/__init__.py b/rdflib/plugins/parsers/__init__.py index 8062daa4a..8748bfce7 100644 --- a/rdflib/plugins/parsers/__init__.py +++ b/rdflib/plugins/parsers/__init__.py @@ -1,3 +1,2 @@ -""" - +"""Modules for parsing serialized RDF such as Turtle, JSON-LD etc. """ diff --git a/rdflib/plugins/serializers/__init__.py b/rdflib/plugins/serializers/__init__.py index e69de29bb..036686ace 100644 --- a/rdflib/plugins/serializers/__init__.py +++ b/rdflib/plugins/serializers/__init__.py @@ -0,0 +1,2 @@ +"""Modules for serializing RDFLib graphs into XML, HexTuples, N3, Turtle etc. +""" diff --git a/rdflib/plugins/shared/__init__.py b/rdflib/plugins/shared/__init__.py index e69de29bb..98734b6fb 100644 --- a/rdflib/plugins/shared/__init__.py +++ b/rdflib/plugins/shared/__init__.py @@ -0,0 +1 @@ +"""Modules shared by serializers & parsers. Currently only JSON-LD code.""" diff --git a/rdflib/plugins/sparql/__init__.py b/rdflib/plugins/sparql/__init__.py index c59dd13f4..8d29e8d07 100644 --- a/rdflib/plugins/sparql/__init__.py +++ b/rdflib/plugins/sparql/__init__.py @@ -1,6 +1,4 @@ """SPARQL implementation for RDFLib - -!!! example "New in version 4.0" """ from importlib.metadata import entry_points diff --git a/rdflib/plugins/stores/__init__.py b/rdflib/plugins/stores/__init__.py index 2eb475636..6e394f97a 100644 --- a/rdflib/plugins/stores/__init__.py +++ b/rdflib/plugins/stores/__init__.py @@ -1,3 +1,3 @@ """ -This package contains modules for additional RDFLib stores +Modules for additional RDFLib stores """