Updated README and docs index

neo4j-contrib · Jun 14, 2021 · 603abd4 · 603abd4
1 parent 6094d2d
commit 603abd4
Show file tree

Hide file tree

Showing 2 changed files with 156 additions and 90 deletions.
diff --git a/README.rst b/README.rst
@@ -1,8 +1,12 @@
 Py2neo
 ======
-.. image:: https://img.shields.io/github/v/release/technige/py2neo?sort=semver
-   :target: https://github.com/technige/py2neo
-   :alt: GitHub release
+.. image:: https://img.shields.io/pypi/v/py2neo.svg
+   :target: https://pypi.python.org/pypi/py2neo
+   :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/py2neo
+   :target: https://pypi.python.org/pypi/py2neo
+   :alt: PyPI Downloads
 
 .. image:: https://img.shields.io/github/license/technige/py2neo.svg
    :target: https://www.apache.org/licenses/LICENSE-2.0
@@ -16,63 +20,18 @@ Py2neo
 **Py2neo** is a client library and toolkit for working with `Neo4j <https://neo4j.com/>`_ from within `Python <https://www.python.org/>`_ applications and from the command line.
 The library supports both Bolt and HTTP and provides a high level API, an OGM, admin tools, an interactive console, a Cypher lexer for Pygments, and many other bells and whistles.
 
-As of version 2021.1, Py2neo contains full support for routing, as exposed by a Neo4j cluster.
+As of version 2021.1, py2neo contains full support for routing, as exposed by a Neo4j cluster.
 This can be enabled using a ``neo4j://...`` URI or by passing ``routing=True`` to a ``Graph`` constructor.
 
 
-Quick Example
--------------
-
-To run a query against a local database is straightforward::
-
-    >>> from py2neo import Graph
-    >>> graph = Graph("bolt://localhost:7687", auth=("neo4j", "password"))
-    >>> graph.run("UNWIND range(1, 3) AS n RETURN n, n * n as n_sq")
-       n | n_sq
-    -----|------
-       1 |    1
-       2 |    4
-       3 |    9
-
-
-Releases & Versioning
----------------------
-
-As of 2020, py2neo has switched to `Calendar Versioning <https://calver.org/>`_, using a scheme of ``YYYY.N.M``.
-Here, ``N`` is an incrementing zero-based number for each year, and ``M`` is a revision within that version (also zero-based).
-
-No compatibility guarantees are given between versions, but as a general rule, a change in ``M`` should require little-to-no work within client applications,
-whereas a change in ``N`` may require some work. A change to the year is likely to require a more significant amount of work to upgrade.
-
-Note that py2neo is developed on a rolling basis, so patches are not made to old versions.
-Users will instead need to install the latest release to adopt bug fixes.
-
-
-Installation
-------------
-.. image:: https://img.shields.io/pypi/v/py2neo.svg
-   :target: https://pypi.python.org/pypi/py2neo
-   :alt: PyPI version
-
-.. image:: https://img.shields.io/pypi/dm/py2neo
-   :target: https://pypi.python.org/pypi/py2neo
-   :alt: PyPI Downloads
+Installation & Compatibility
+----------------------------
 
 To install the latest release of py2neo, simply use:
 
-.. code-block::
-
-    $ pip install --upgrade py2neo
-
-To install the latest stable code from the GitHub master branch, use:
-
-.. code-block::
+.. code-block:: bash
 
-    $ pip install git+https://github.com/technige/py2neo.git@master#egg=py2neo
-
-
-Compatibility
--------------
+    $ pip install py2neo
 
 The following versions of Python and Neo4j (all editions) are supported:
 
@@ -101,9 +60,44 @@ The following versions of Python and Neo4j (all editions) are supported:
       - |test-neo34-py35+|
       - |test-neo34-py27-py34|
 
-Note that Py2neo is developed and tested under **Linux** using standard CPython distributions.
+Note that py2neo is developed and tested under **Linux** using standard CPython distributions.
 While other operating systems and Python distributions may work, support for these is not available.
 
+
+Quick Example
+-------------
+
+To run a query against a local database is straightforward::
+
+    >>> from py2neo import Graph
+    >>> graph = Graph("bolt://localhost:7687", auth=("neo4j", "password"))
+    >>> graph.run("UNWIND range(1, 3) AS n RETURN n, n * n as n_sq")
+       n | n_sq
+    -----|------
+       1 |    1
+       2 |    4
+       3 |    9
+
+
+Releases & Versioning
+---------------------
+
+As of 2020, py2neo has switched to `Calendar Versioning <https://calver.org/>`_, using a scheme of ``YYYY.N.M``.
+Here, ``N`` is an incrementing zero-based number for each year, and ``M`` is a revision within that version (also zero-based).
+
+No compatibility guarantees are given between versions, but as a general rule, a change in ``M`` should require little-to-no work within client applications,
+whereas a change in ``N`` may require some work. A change to the year is likely to require a more significant amount of work to upgrade.
+
+Note that py2neo is developed on a rolling basis, so patches are not made to old versions.
+Users will instead need to install the latest release to adopt bug fixes.
+
+
+More
+----
+
+For more information, read the `handbook <http://py2neo.org/>`_.
+
+
 .. |test-neo43-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py27-py34
    :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py27-py34"
    :alt: GitHub workflow status for tests against Neo4j 4.3 using py27/py34
@@ -151,9 +145,3 @@ While other operating systems and Python distributions may work, support for the
 .. |test-neo34-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py35+
    :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py35+"
    :alt: GitHub workflow status for tests against Neo4j 3.4 using py35+
-
-
-More
-----
-
-For more information, read the `handbook <http://py2neo.org/>`_.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,16 +1,75 @@
 *******************
 The Py2neo Handbook
 *******************
+.. image:: https://img.shields.io/pypi/v/py2neo.svg
+   :target: https://pypi.python.org/pypi/py2neo
+   :alt: PyPI version
+
+.. image:: https://img.shields.io/pypi/dm/py2neo
+   :target: https://pypi.python.org/pypi/py2neo
+   :alt: PyPI Downloads
+
+.. image:: https://img.shields.io/github/license/technige/py2neo.svg
+   :target: https://www.apache.org/licenses/LICENSE-2.0
+   :alt: License
+
+.. image:: https://coveralls.io/repos/github/technige/py2neo/badge.svg?branch=master
+   :target: https://coveralls.io/github/technige/py2neo?branch=master
+   :alt: Coverage Status
+
 
 **Py2neo** is a client library and toolkit for working with Neo4j_ from within Python_ applications and from the command line.
 The library supports both Bolt and HTTP and provides a high level API, an OGM, admin tools, an interactive console, a Cypher lexer for Pygments, and many other bells and whistles.
 
 As of version 2021.1, Py2neo contains full support for routing, as exposed by a Neo4j cluster.
 This can be enabled using a ``neo4j://...`` URI or by passing ``routing=True`` to a :class:`.Graph` constructor.
 
+Py2neo also provides support for the multi-database functionality added in Neo4j 4.0.
+More about this can be found in the documentation for the :class:`.Graph` class.
+
 Remember to take a look at the full :ref:`release notes <Version 2021.1>` for version 2021.1.
 
 
+Installation & Compatibility
+============================
+
+To install the latest release of py2neo, simply use:
+
+.. code-block:: bash
+
+    $ pip install py2neo
+
+The following versions of Python and Neo4j (all editions) are supported:
+
+.. list-table::
+    :header-rows: 1
+
+    * - Neo4j
+      - Python 3.5+
+      - Python 2.7 and 3.4
+    * - 4.3
+      - |test-neo43-py35+|
+      - |test-neo43-py27-py34|
+    * - 4.2
+      - |test-neo42-py35+|
+      - |test-neo42-py27-py34|
+    * - 4.1
+      - |test-neo41-py35+|
+      - |test-neo41-py27-py34|
+    * - 4.0
+      - |test-neo40-py35+|
+      - |test-neo40-py27-py34|
+    * - 3.5
+      - |test-neo35-py35+|
+      - |test-neo35-py27-py34|
+    * - 3.4
+      - |test-neo34-py35+|
+      - |test-neo34-py27-py34|
+
+Note that py2neo is developed and tested under **Linux** using standard CPython distributions.
+While other operating systems and Python distributions may work, support for these is not available.
+
+
 Quick Example
 =============
 
@@ -39,36 +98,6 @@ Note that py2neo is developed on a rolling basis, so patches are not made to old
 Users will instead need to install the latest release to adopt bug fixes.
 
 
-Installation
-============
-
-To install the latest release of py2neo, simply use:
-
-.. code-block:: bash
-
-    $ pip install --upgrade py2neo
-
-To install the latest stable code from the GitHub master branch, use:
-
-.. code-block:: bash
-
-    $ pip install git+https://github.com/technige/py2neo.git@master#egg=py2neo
-
-
-Requirements
-============
-
-The following versions of Python and Neo4j (all editions) are supported:
-
-- Python 2.7 / 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9
-- Neo4j 3.4 / 3.5 / 4.0 / 4.1 / 4.2 / 4.3 (the latest point release of each version is recommended)
-
-Py2neo provides support for the multi-database functionality added in Neo4j 4.0.
-More about this can be found in the documentation for the :class:`.Graph` class.
-
-Note that Py2neo is developed and tested under **Linux** using standard CPython distributions.
-While other operating systems and Python distributions may work, support for these is not available.
-
 Core Graph API
 ==============
 
@@ -150,3 +179,52 @@ Command Line Tools
 .. _pip: https://pip.pypa.io/
 .. _Python: https://www.python.org/
 .. _Causal Clustering: https://neo4j.com/docs/operations-manual/current/clustering/
+
+
+.. |test-neo43-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 4.3 using py27/py34
+
+.. |test-neo43-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 4.3 using py35+
+
+.. |test-neo42-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo42-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo42-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 4.2 using py27/py34
+
+.. |test-neo42-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo42-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo42-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 4.2 using py35+
+
+.. |test-neo41-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo41-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo41-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 4.1 using py27/py34
+
+.. |test-neo41-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo41-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo41-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 4.1 using py35+
+
+.. |test-neo40-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo40-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo40-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 4.0 using py27/py34
+
+.. |test-neo40-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo40-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo40-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 4.0 using py35+
+
+.. |test-neo35-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo35-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo35-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 3.5 using py27/py34
+
+.. |test-neo35-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo35-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo35-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 3.5 using py35+
+
+.. |test-neo34-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py27-py34
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py27-py34"
+   :alt: GitHub workflow status for tests against Neo4j 3.4 using py27/py34
+
+.. |test-neo34-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py35+
+   :target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py35+"
+   :alt: GitHub workflow status for tests against Neo4j 3.4 using py35+