Skip to content

Commit 5260cc5

Browse files
author
matmoncon
committed
docs: update supported pydantic versions in docs
1 parent 535291a commit 5260cc5

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@
55
[![PyPI - License](https://img.shields.io/pypi/l/pyneo4j-ogm?style=flat-square)](https://pypi.org/project/pyneo4j-ogm/)
66
[![PyPI - Downloads](https://img.shields.io/pypi/dm/pyneo4j-ogm?style=flat-square)](https://pypi.org/project/pyneo4j-ogm/)
77

8-
`pyneo4j-ogm` is a asynchronous `Object-Graph-Mapper` for [`Neo4j 5+`](https://neo4j.com/docs/) and [`Python 3.10+`](https://www.python.org/). It is inspired by [`beanie`](https://github.com/roman-right/beanie) and build on top of proven technologies like [`Pydantic 1.10`](https://docs.pydantic.dev/1.10/) and the [`Neo4j Python Driver`](https://neo4j.com/docs/api/python-driver/current/index.html). It saves you from writing ever-repeating boilerplate queries and allows you to focus on the `stuff that actually matters`. It is designed to be simple and easy to use, but also flexible and powerful.
8+
`pyneo4j-ogm` is a asynchronous `Object-Graph-Mapper` for [`Neo4j 5+`](https://neo4j.com/docs/) and [`Python 3.10+`](https://www.python.org/). It is inspired by [`beanie`](https://github.com/roman-right/beanie) and build on top of proven technologies like [`Pydantic 1.10+`](https://docs.pydantic.dev/latest/) and the [`Neo4j Python Driver`](https://neo4j.com/docs/api/python-driver/current/index.html). It saves you from writing ever-repeating boilerplate queries and allows you to focus on the `stuff that actually matters`. It is designed to be simple and easy to use, but also flexible and powerful.
99

1010
## 📣 Upcoming features
1111

1212
What's planned for future releases.
1313

14-
- [ ] Support for `Pydantic V2`
15-
- [ ] Bookmark support
1614
- [ ] Migration CLI for migrating your pyneo4j-ogm models
15+
- [ ] Bookmark support
1716

1817
## 🎯 Features <a name="features"></a>
1918

@@ -548,7 +547,7 @@ Filters for nested properties are also not supported, since they are stored as s
548547

549548
#### Indexes, constraints and properties <a name="indexes-constraints-and-properties"></a>
550549

551-
Since `pyneo4j-ogm` is built on top of `Pydantic`, all of the features provided by `Pydantic` are available to you. This includes defining `properties` on your models. For more information about these features, please refer to the [`Pydantic documentation`](https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization).
550+
Since `pyneo4j-ogm` is built on top of `Pydantic`, all of the features provided by `Pydantic` are available to you. This includes defining `properties` on your models. For more information about these features, please refer to the [`Pydantic documentation`](https://docs.pydantic.dev/latest/concepts/json_schema/#schema-customization).
552551

553552
On the other hand, `indexes and constraints` are handled solely by `pyneo4j-ogm`. You can define indexes and constraints on your models by using the `WithOptions` method wrapped around the type of the property. You can pass the following arguments to the `WithOptions` method:
554553

@@ -1182,7 +1181,7 @@ Because most frontend applications use `camelCase` for their properties, the `ex
11821181

11831182
##### Instance.export_model() <a name="instance-export-model"></a>
11841183

1185-
Export the model instance to a dictionary containing standard python types. Since this method uses `pydantic.BaseModel.json()` internally, all arguments it accepts are also accepted by this method.
1184+
Export the model instance to a dictionary containing standard python types. Since this method uses `pydantic.BaseModel.model_dump_json()` internally, all arguments it accepts are also accepted by this method.
11861185

11871186
```python
11881187
developer = await Developer(

0 commit comments

Comments
 (0)