summaryrefslogtreecommitdiff
path: root/docs/index.rst
blob: 0ebb1741c6ff458b8555949198d1407b3dc625e4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
.. rdflib documentation documentation master file

================
rdflib |release|
================

RDFLib is a pure Python package for working with `RDF <http://www.w3.org/RDF/>`_. It contains:

* **Parsers & Serializers**

  * for RDF/XML, N3, NTriples, N-Quads, Turtle, TriX, JSON-LD, RDFa and Microdata


* **Store implementations**

  * for in-memory and persistent RDF storage, including remote SPARQL endpoints

* **Graph interface**

  * to a single graph
  * or a conjunctive graph (multiple Named Graphs)
  * or a dataset of graphs

* **SPARQL 1.1 implementation**

  * both Queries and Updates are supported


Getting started
---------------
If you have never used RDFLib, the following will help get you started:

.. toctree::
   :maxdepth: 1

   gettingstarted
   intro_to_parsing
   intro_to_creating_rdf
   intro_to_graphs
   intro_to_sparql
   utilities
   Examples <apidocs/examples>


In depth
--------
If you are familiar with RDF and are looking for details on how RDFLib handles it, these are for you:

.. toctree::
   :maxdepth: 1

   rdf_terms
   namespaces_and_bindings
   persistence
   merging
   upgrade5to6
   upgrade4to5


Reference
---------
The nitty-gritty details of everything.

API reference:

.. toctree::
   :maxdepth: 1

   apidocs/modules

.. toctree::
   :maxdepth: 2

   plugins

.. * :ref:`genindex`
.. * :ref:`modindex`


For developers
--------------
.. toctree::
   :maxdepth: 1

   developers
   docs
   persisting_n3_terms

Source Code
-----------
The rdflib source code is hosted on GitHub at `<https://github.com/RDFLib/rdflib>`__ where you can lodge Issues and
create Pull Requests to help improve this community project!

The RDFlib organisation on GitHub at `<https://github.com/RDFLib>`__ maintains this package and a number of other RDF
and RDFlib-related packaged that you might also find useful.


Further help & Contact
----------------------

If you would like more help with using rdflib, rather than developing it, please post a question on StackOverflow using
the tag ``[rdflib]``. A list of existing ``[rdflib]`` tagged questions is kept there at:

* `<https://stackoverflow.com/questions/tagged/rdflib>`__

You might also like to join rdflib's dev mailing list: `<https://groups.google.com/group/rdflib-dev>`__

The chat is available at `gitter <https://gitter.im/RDFLib/rdflib>`_ or via matrix `#RDFLib_rdflib:gitter.im <https://matrix.to/#/#RDFLib_rdflib:gitter.im>`_.



Glossary
--------

Here are a few RDF and Python terms referred to in this documentation. They are linked to wherever they occur.

.. glossary::

    functional property
        Properties than can only occur once for a resource, i.e. for any relation (triple, in RDF) ``x p y``,
        if ``p`` is functional, for any individual ``x``, there can be at most one individual ``y``.

    OWL
        The OWL 2 Web Ontology Language, informally OWL 2 or just OWL, is an ontology language for the Semantic Web
        with formally defined meaning. OWL 2 ontologies provide classes, properties, individuals, and data values and
        are stored as Semantic Web documents. OWL 2 ontologies can be used along with information written in RDF, and
        OWL 2 ontologies themselves are primarily exchanged as RDF documents. See the `RDF 1.1 Concepts and Abstract
        Syntax <https://www.w3.org/TR/rdf11-concepts/>`_ for more info.

    RDF
        The Resource Description Framework (RDF) is a framework for representing information in the Web. RDF data is
        stored in graphs that are sets of subject-predicate-object triples, where the elements may be IRIs, blank nodes,
        or datatyped literals. See the `OWL 2 Web Ontology Language
        Document Overview <http://www.w3.org/TR/owl-overview/>`_ for more info.