Skip to content

Commit 603abd4

Browse files
technigetechnige
committed
Updated README and docs index
1 parent 6094d2d commit 603abd4

File tree

2 files changed

+156
-90
lines changed

2 files changed

+156
-90
lines changed

‎README.rst

Lines changed: 48 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
Py2neo
22
======
3-
.. image:: https://img.shields.io/github/v/release/technige/py2neo?sort=semver
4-
:target: https://github.com/technige/py2neo
5-
:alt: GitHub release
3+
.. image:: https://img.shields.io/pypi/v/py2neo.svg
4+
:target: https://pypi.python.org/pypi/py2neo
5+
:alt: PyPI version
6+
7+
.. image:: https://img.shields.io/pypi/dm/py2neo
8+
:target: https://pypi.python.org/pypi/py2neo
9+
:alt: PyPI Downloads
610

711
.. image:: https://img.shields.io/github/license/technige/py2neo.svg
812
:target: https://www.apache.org/licenses/LICENSE-2.0
@@ -16,63 +20,18 @@ Py2neo
1620
**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.
1721
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.
1822

19-
As of version 2021.1, Py2neo contains full support for routing, as exposed by a Neo4j cluster.
23+
As of version 2021.1, py2neo contains full support for routing, as exposed by a Neo4j cluster.
2024
This can be enabled using a ``neo4j://...`` URI or by passing ``routing=True`` to a ``Graph`` constructor.
2125

2226

23-
Quick Example
24-
-------------
25-
26-
To run a query against a local database is straightforward::
27-
28-
>>> from py2neo import Graph
29-
>>> graph = Graph("bolt://localhost:7687", auth=("neo4j", "password"))
30-
>>> graph.run("UNWIND range(1, 3) AS n RETURN n, n * n as n_sq")
31-
n | n_sq
32-
-----|------
33-
1 | 1
34-
2 | 4
35-
3 | 9
36-
37-
38-
Releases & Versioning
39-
---------------------
40-
41-
As of 2020, py2neo has switched to `Calendar Versioning <https://calver.org/>`_, using a scheme of ``YYYY.N.M``.
42-
Here, ``N`` is an incrementing zero-based number for each year, and ``M`` is a revision within that version (also zero-based).
43-
44-
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,
45-
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.
46-
47-
Note that py2neo is developed on a rolling basis, so patches are not made to old versions.
48-
Users will instead need to install the latest release to adopt bug fixes.
49-
50-
51-
Installation
52-
------------
53-
.. image:: https://img.shields.io/pypi/v/py2neo.svg
54-
:target: https://pypi.python.org/pypi/py2neo
55-
:alt: PyPI version
56-
57-
.. image:: https://img.shields.io/pypi/dm/py2neo
58-
:target: https://pypi.python.org/pypi/py2neo
59-
:alt: PyPI Downloads
27+
Installation & Compatibility
28+
----------------------------
6029

6130
To install the latest release of py2neo, simply use:
6231

63-
.. code-block::
64-
65-
$ pip install --upgrade py2neo
66-
67-
To install the latest stable code from the GitHub master branch, use:
68-
69-
.. code-block::
32+
.. code-block:: bash
7033
71-
$ pip install git+https://github.com/technige/py2neo.git@master#egg=py2neo
72-
73-
74-
Compatibility
75-
-------------
34+
$ pip install py2neo
7635
7736
The following versions of Python and Neo4j (all editions) are supported:
7837

@@ -101,9 +60,44 @@ The following versions of Python and Neo4j (all editions) are supported:
10160
- |test-neo34-py35+|
10261
- |test-neo34-py27-py34|
10362

104-
Note that Py2neo is developed and tested under **Linux** using standard CPython distributions.
63+
Note that py2neo is developed and tested under **Linux** using standard CPython distributions.
10564
While other operating systems and Python distributions may work, support for these is not available.
10665

66+
67+
Quick Example
68+
-------------
69+
70+
To run a query against a local database is straightforward::
71+
72+
>>> from py2neo import Graph
73+
>>> graph = Graph("bolt://localhost:7687", auth=("neo4j", "password"))
74+
>>> graph.run("UNWIND range(1, 3) AS n RETURN n, n * n as n_sq")
75+
n | n_sq
76+
-----|------
77+
1 | 1
78+
2 | 4
79+
3 | 9
80+
81+
82+
Releases & Versioning
83+
---------------------
84+
85+
As of 2020, py2neo has switched to `Calendar Versioning <https://calver.org/>`_, using a scheme of ``YYYY.N.M``.
86+
Here, ``N`` is an incrementing zero-based number for each year, and ``M`` is a revision within that version (also zero-based).
87+
88+
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,
89+
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.
90+
91+
Note that py2neo is developed on a rolling basis, so patches are not made to old versions.
92+
Users will instead need to install the latest release to adopt bug fixes.
93+
94+
95+
More
96+
----
97+
98+
For more information, read the `handbook <http://py2neo.org/>`_.
99+
100+
107101
.. |test-neo43-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py27-py34
108102
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py27-py34"
109103
: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
151145
.. |test-neo34-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py35+
152146
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py35+"
153147
:alt: GitHub workflow status for tests against Neo4j 3.4 using py35+
154-
155-
156-
More
157-
----
158-
159-
For more information, read the `handbook <http://py2neo.org/>`_.

‎docs/index.rst

Lines changed: 108 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,75 @@
11
*******************
22
The Py2neo Handbook
33
*******************
4+
.. image:: https://img.shields.io/pypi/v/py2neo.svg
5+
:target: https://pypi.python.org/pypi/py2neo
6+
:alt: PyPI version
7+
8+
.. image:: https://img.shields.io/pypi/dm/py2neo
9+
:target: https://pypi.python.org/pypi/py2neo
10+
:alt: PyPI Downloads
11+
12+
.. image:: https://img.shields.io/github/license/technige/py2neo.svg
13+
:target: https://www.apache.org/licenses/LICENSE-2.0
14+
:alt: License
15+
16+
.. image:: https://coveralls.io/repos/github/technige/py2neo/badge.svg?branch=master
17+
:target: https://coveralls.io/github/technige/py2neo?branch=master
18+
:alt: Coverage Status
19+
420

521
**Py2neo** is a client library and toolkit for working with Neo4j_ from within Python_ applications and from the command line.
622
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.
723

824
As of version 2021.1, Py2neo contains full support for routing, as exposed by a Neo4j cluster.
925
This can be enabled using a ``neo4j://...`` URI or by passing ``routing=True`` to a :class:`.Graph` constructor.
1026

27+
Py2neo also provides support for the multi-database functionality added in Neo4j 4.0.
28+
More about this can be found in the documentation for the :class:`.Graph` class.
29+
1130
Remember to take a look at the full :ref:`release notes <Version 2021.1>` for version 2021.1.
1231

1332

33+
Installation & Compatibility
34+
============================
35+
36+
To install the latest release of py2neo, simply use:
37+
38+
.. code-block:: bash
39+
40+
$ pip install py2neo
41+
42+
The following versions of Python and Neo4j (all editions) are supported:
43+
44+
.. list-table::
45+
:header-rows: 1
46+
47+
* - Neo4j
48+
- Python 3.5+
49+
- Python 2.7 and 3.4
50+
* - 4.3
51+
- |test-neo43-py35+|
52+
- |test-neo43-py27-py34|
53+
* - 4.2
54+
- |test-neo42-py35+|
55+
- |test-neo42-py27-py34|
56+
* - 4.1
57+
- |test-neo41-py35+|
58+
- |test-neo41-py27-py34|
59+
* - 4.0
60+
- |test-neo40-py35+|
61+
- |test-neo40-py27-py34|
62+
* - 3.5
63+
- |test-neo35-py35+|
64+
- |test-neo35-py27-py34|
65+
* - 3.4
66+
- |test-neo34-py35+|
67+
- |test-neo34-py27-py34|
68+
69+
Note that py2neo is developed and tested under **Linux** using standard CPython distributions.
70+
While other operating systems and Python distributions may work, support for these is not available.
71+
72+
1473
Quick Example
1574
=============
1675

@@ -39,36 +98,6 @@ Note that py2neo is developed on a rolling basis, so patches are not made to old
3998
Users will instead need to install the latest release to adopt bug fixes.
4099

41100

42-
Installation
43-
============
44-
45-
To install the latest release of py2neo, simply use:
46-
47-
.. code-block:: bash
48-
49-
$ pip install --upgrade py2neo
50-
51-
To install the latest stable code from the GitHub master branch, use:
52-
53-
.. code-block:: bash
54-
55-
$ pip install git+https://github.com/technige/py2neo.git@master#egg=py2neo
56-
57-
58-
Requirements
59-
============
60-
61-
The following versions of Python and Neo4j (all editions) are supported:
62-
63-
- Python 2.7 / 3.4 / 3.5 / 3.6 / 3.7 / 3.8 / 3.9
64-
- Neo4j 3.4 / 3.5 / 4.0 / 4.1 / 4.2 / 4.3 (the latest point release of each version is recommended)
65-
66-
Py2neo provides support for the multi-database functionality added in Neo4j 4.0.
67-
More about this can be found in the documentation for the :class:`.Graph` class.
68-
69-
Note that Py2neo is developed and tested under **Linux** using standard CPython distributions.
70-
While other operating systems and Python distributions may work, support for these is not available.
71-
72101
Core Graph API
73102
==============
74103

@@ -150,3 +179,52 @@ Command Line Tools
150179
.. _pip: https://pip.pypa.io/
151180
.. _Python: https://www.python.org/
152181
.. _Causal Clustering: https://neo4j.com/docs/operations-manual/current/clustering/
182+
183+
184+
.. |test-neo43-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py27-py34
185+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py27-py34"
186+
:alt: GitHub workflow status for tests against Neo4j 4.3 using py27/py34
187+
188+
.. |test-neo43-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo43-py35+
189+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo43-py35+"
190+
:alt: GitHub workflow status for tests against Neo4j 4.3 using py35+
191+
192+
.. |test-neo42-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo42-py27-py34
193+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo42-py27-py34"
194+
:alt: GitHub workflow status for tests against Neo4j 4.2 using py27/py34
195+
196+
.. |test-neo42-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo42-py35+
197+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo42-py35+"
198+
:alt: GitHub workflow status for tests against Neo4j 4.2 using py35+
199+
200+
.. |test-neo41-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo41-py27-py34
201+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo41-py27-py34"
202+
:alt: GitHub workflow status for tests against Neo4j 4.1 using py27/py34
203+
204+
.. |test-neo41-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo41-py35+
205+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo41-py35+"
206+
:alt: GitHub workflow status for tests against Neo4j 4.1 using py35+
207+
208+
.. |test-neo40-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo40-py27-py34
209+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo40-py27-py34"
210+
:alt: GitHub workflow status for tests against Neo4j 4.0 using py27/py34
211+
212+
.. |test-neo40-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo40-py35+
213+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo40-py35+"
214+
:alt: GitHub workflow status for tests against Neo4j 4.0 using py35+
215+
216+
.. |test-neo35-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo35-py27-py34
217+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo35-py27-py34"
218+
:alt: GitHub workflow status for tests against Neo4j 3.5 using py27/py34
219+
220+
.. |test-neo35-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo35-py35+
221+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo35-py35+"
222+
:alt: GitHub workflow status for tests against Neo4j 3.5 using py35+
223+
224+
.. |test-neo34-py27-py34| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py27-py34
225+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py27-py34"
226+
:alt: GitHub workflow status for tests against Neo4j 3.4 using py27/py34
227+
228+
.. |test-neo34-py35+| image:: https://img.shields.io/github/workflow/status/technige/py2neo/test-neo34-py35+
229+
:target: https://github.com/technige/py2neo/actions?query=workflow%3A"test-neo34-py35+"
230+
:alt: GitHub workflow status for tests against Neo4j 3.4 using py35+

0 commit comments

Comments
 (0)