Skip to content

Commit 0bdafb4

Browse files
committed
Mature the project
* The project has been moved to the neo4j GitHub org => update links * Add a `CHANGELOG.md` * Fix maturin version to `~=1.6.0` => Bump MSRV to `1.67`
1 parent 3077daa commit 0bdafb4

File tree

3 files changed

+62
-9
lines changed

3 files changed

+62
-9
lines changed

CHANGELOG.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
Changelog
2+
=========
3+
4+
## Next Release
5+
* Moved repository:
6+
from https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext
7+
to https://github.com/neo4j/neo4j-python-driver-rust-ext
8+
* Metadata: removed `Beta` tag, added `Production/Stable`.
9+
* Bump MSRV (minimum supported Rust version) to 1.67.0.
10+
* Clarify installation documentation: `neo4j` and `neo4j-rust-ext` can both be installed at the same time.
11+
ℹ️ Make sure to specify matching versions if you do so.
12+
13+
14+
## 5.23.0.0 (2024-07-29)
15+
* Target driver version 5.23.0
16+
17+
18+
## 5.22.0.0 (2024-06-27)
19+
* Target driver version 5.22.0
20+
21+
22+
## 5.21.0.0 (2024-06-11)
23+
* Target driver version 5.21.0
24+
25+
26+
## 5.20.0.0 (2024-04-26)
27+
* Target driver version 5.20.0
28+
29+
30+
## 5.19.0.0 (2024-05-02)
31+
* Target driver version 5.19.0
32+
33+
34+
## 5.18.0.0 (2024-02-29)
35+
* Target driver version 5.18.0
36+
37+
38+
## 5.17.0.0b1 (2024-01-29)
39+
* Target driver version 5.17.0
40+
41+
42+
## 5.16.0.0b1 (2023-12-28)
43+
* Target driver version 5.16.0
44+
45+
46+
## 5.15.0.0b1 (2023-11-28)
47+
* Target driver version 5.15.0
48+
49+
50+
## 5.14.1.0a1 (2023-11-03)
51+
* Target driver version 5.14.1
52+
* Initial release.

README.md

+5-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This project contains Rust extensions to speed up the [official Python driver for Neo4j](https://github.com/neo4j/neo4j-python-driver).
44

5-
The exact speedup depends on the use-case but has been measured to be between 3x and 10x faster.
5+
The exact speedup depends on the use-case but has been measured to be up to 10x faster.
66
Use-cases moving only few but big records out of the DBMS tend to benefit the most.
77

88

@@ -20,6 +20,9 @@ That's it!
2020
You don't have to change your code but can use the driver as you normally would.
2121
This package will install the driver as its dependency and then inject itself in a place where the driver can find it and pick it up.
2222

23+
N.B., since the driver is a simple Python dependency of this package, you can also manually install/specify both packages at the same time without issues.
24+
However, make sure the versions match if you do so or leave the version of one of the two unspecified to let the package manager pick a compatible version for you (resolution might be slow, however).
25+
2326
If you experience issues with the driver, consider troubleshooting without the Rust extension first.
2427
For that, simply make sure you haven't installed `neo4j-rust-ext` but *only* `neo4j`.
2528

@@ -28,7 +31,7 @@ For that, simply make sure you haven't installed `neo4j-rust-ext` but *only* `ne
2831
For many operating systems and architectures, the pre-built wheels will work out of the box.
2932
If they don't, pip (or any other Python packaging front-end) will try to build the extension from source.
3033
Here's what you'll need for this:
31-
* Rust 1.65.0 or later:
34+
* Rust 1.67.0 or later:
3235
https://www.rust-lang.org/tools/install
3336
* Further build tools (depending on the platform).
3437
E.g., `gcc` on Ubuntu: `sudo apt install gcc`

pyproject.toml

+5-7
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,15 @@ description = "Rust Extensions for a Faster Neo4j Bolt Driver for Python"
1919
license = {text = "Apache License, Version 2.0"}
2020
readme = "README.md"
2121
authors = [
22-
# Can be changed back when https://github.com/PyO3/maturin/pull/1832 is merged and released
23-
# {name = "Neo4j, Inc.", email = "[email protected]"},
24-
{email = "\"Neo4j, Inc.\" <[email protected]>"}
22+
{name = "Neo4j, Inc.", email = "[email protected]"},
2523
]
2624
dependencies = [
2725
"neo4j == 5.23.0"
2826
]
2927
requires-python = ">=3.7"
3028
keywords = ["neo4j", "graph", "database"]
3129
classifiers = [
32-
"Development Status :: 4 - Beta",
30+
"Development Status :: 5 - Production/Stable",
3331
"Intended Audience :: Developers",
3432
"License :: OSI Approved :: Apache Software License",
3533
"Operating System :: OS Independent",
@@ -47,8 +45,8 @@ version = "5.23.0.0"
4745

4846
[project.urls]
4947
Homepage = "https://neo4j.com/"
50-
Repository = "https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext"
51-
"Issue Tracker" = "https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext/issues"
48+
Repository = "https://github.com/neo4j/neo4j-python-driver-rust-ext"
49+
"Issue Tracker" = "https://github.com/neo4j/neo4j-python-driver-rust-ext/issues"
5250
Forum = "https://community.neo4j.com/c/drivers-stacks/python/"
5351
Discord = "https://discord.com/invite/neo4j"
5452

@@ -58,7 +56,7 @@ pandas = ["neo4j[pandas]"]
5856
pyarrow = ["neo4j[pyarrow]"]
5957

6058
[build-system]
61-
requires = ["maturin>=1.2,<2.0"]
59+
requires = ["maturin ~= 1.6.0"]
6260
build-backend = "maturin"
6361

6462
[tool.maturin]

0 commit comments

Comments
 (0)