diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..d32a92d --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,52 @@ +Changelog +========= + +## Next Release +* Moved repository: + from https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext + to https://github.com/neo4j/neo4j-python-driver-rust-ext +* Metadata: removed `Beta` tag, added `Production/Stable`. +* Bump MSRV (minimum supported Rust version) to 1.67.0. +* Clarify installation documentation: `neo4j` and `neo4j-rust-ext` can both be installed at the same time. + ℹ️ Make sure to specify matching versions if you do so. + + +## 5.23.0.0 (2024-07-29) +* Target driver version 5.23.0 + + +## 5.22.0.0 (2024-06-27) +* Target driver version 5.22.0 + + +## 5.21.0.0 (2024-06-11) +* Target driver version 5.21.0 + + +## 5.20.0.0 (2024-04-26) +* Target driver version 5.20.0 + + +## 5.19.0.0 (2024-05-02) +* Target driver version 5.19.0 + + +## 5.18.0.0 (2024-02-29) +* Target driver version 5.18.0 + + +## 5.17.0.0b1 (2024-01-29) +* Target driver version 5.17.0 + + +## 5.16.0.0b1 (2023-12-28) +* Target driver version 5.16.0 + + +## 5.15.0.0b1 (2023-11-28) +* Target driver version 5.15.0 + + +## 5.14.1.0a1 (2023-11-03) +* Target driver version 5.14.1 +* Initial release. diff --git a/README.md b/README.md index 62a7b75..1f3feca 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This project contains Rust extensions to speed up the [official Python driver for Neo4j](https://github.com/neo4j/neo4j-python-driver). -The exact speedup depends on the use-case but has been measured to be between 3x and 10x faster. +The exact speedup depends on the use-case but has been measured to be up to 10x faster. Use-cases moving only few but big records out of the DBMS tend to benefit the most. @@ -20,6 +20,9 @@ That's it! You don't have to change your code but can use the driver as you normally would. 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. +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. +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). + If you experience issues with the driver, consider troubleshooting without the Rust extension first. For that, simply make sure you haven't installed `neo4j-rust-ext` but *only* `neo4j`. @@ -28,7 +31,7 @@ For that, simply make sure you haven't installed `neo4j-rust-ext` but *only* `ne For many operating systems and architectures, the pre-built wheels will work out of the box. If they don't, pip (or any other Python packaging front-end) will try to build the extension from source. Here's what you'll need for this: - * Rust 1.65.0 or later: + * Rust 1.67.0 or later: https://www.rust-lang.org/tools/install * Further build tools (depending on the platform). E.g., `gcc` on Ubuntu: `sudo apt install gcc` diff --git a/pyproject.toml b/pyproject.toml index 4c37717..86cae57 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,9 +19,7 @@ description = "Rust Extensions for a Faster Neo4j Bolt Driver for Python" license = {text = "Apache License, Version 2.0"} readme = "README.md" authors = [ - # Can be changed back when https://github.com/PyO3/maturin/pull/1832 is merged and released - # {name = "Neo4j, Inc.", email = "drivers@neo4j.com"}, - {email = "\"Neo4j, Inc.\" "} + {name = "Neo4j, Inc.", email = "drivers@neo4j.com"}, ] dependencies = [ "neo4j == 5.23.0" @@ -29,7 +27,7 @@ dependencies = [ requires-python = ">=3.7" keywords = ["neo4j", "graph", "database"] classifiers = [ - "Development Status :: 4 - Beta", + "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", @@ -47,8 +45,9 @@ version = "5.23.0.0" [project.urls] Homepage = "https://neo4j.com/" -Repository = "https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext" -"Issue Tracker" = "https://github.com/neo4j-drivers/neo4j-python-driver-rust-ext/issues" +Repository = "https://github.com/neo4j/neo4j-python-driver-rust-ext" +"Issue Tracker" = "https://github.com/neo4j/neo4j-python-driver-rust-ext/issues" +Changelog = "https://github.com/neo4j/neo4j-python-driver-rust-ext/blob/HEAD/CHANGELOG.md" Forum = "https://community.neo4j.com/c/drivers-stacks/python/" Discord = "https://discord.com/invite/neo4j" @@ -58,7 +57,7 @@ pandas = ["neo4j[pandas]"] pyarrow = ["neo4j[pyarrow]"] [build-system] -requires = ["maturin>=1.2,<2.0"] +requires = ["maturin ~= 1.6.0"] build-backend = "maturin" [tool.maturin]