You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
To install GQLAlchemy, you will need the following:
19
+
20
+
-**Python 3.8 - 3.11**
21
+
-`pymgclient`[build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites): GQLAlchemy is built on top of Memgraph's low-level Python client `pymgclient`
22
+
23
+
> [!WARNING]
24
+
> Python 3.11 users: On Windows, GQLAlchemy is not yet compatible with this Python version. Linux users can install GQLAlchemy **without** the DGL extra (due to its dependencies not supporting Python 3.11 yet). If this is currently a blocker for you, please let us know by [opening an issue](https://github.com/memgraph/gqlalchemy/issues).
23
25
24
-
To install GQLAlchemy, you first need to install `pymgclient`[build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites).
26
+
After you’ve installed the prerequisites, run the following command to install
27
+
GQLAlchemy:
25
28
26
-
After you have installed the prerequisites, run the following command:
29
+
```bash
30
+
pip install gqlalchemy
31
+
```
27
32
28
-
`pip install gqlalchemy`
33
+
With the above command, you get the default GQLAlchemy installation which
34
+
doesn’t include import/export support for certain formats (see below). To get
35
+
additional import/export capabilities, use one of the following install options:
29
36
30
-
With the above command, you get the basic GQLAlchemy capabilities. To add additional import/export capabilities, install GQLAlchemy with one of the following commands:
37
+
```bash
38
+
pip install gqlalchemy[arrow] # Support for the CSV, Parquet, ORC and IPC/Feather/Arrow formats
39
+
pip install gqlalchemy[dgl] # DGL support (also includes torch)
40
+
pip install gqlalchemy[docker] # Docker support
31
41
32
-
-`pip install gqlalchemy[arrow]` # Support for the CSV, Parquet, ORC and IPC/Feather/Arrow formats
33
-
-`pip install gqlalchemy[dgl]` # DGL support (includes PyTorch)
34
-
-`pip install gqlalchemy[docker]` # Docker support
42
+
pip install gqlalchemy[all] # All of the above
43
+
```
35
44
36
-
-`pip install gqlalchemy[all]`# All of the above
45
+
If you are using the zsh terminal, surround `gqlalchemy[$extras]`with quotes:
37
46
38
-
Users of the zsh terminal should surround `gqlalchemy[$extras)]` with quotes: `pip install 'gqlalchemy[arrow]'`
47
+
```bash
48
+
pip install 'gqlalchemy[arrow]'
49
+
```
39
50
40
51
If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:
41
52
@@ -54,8 +65,8 @@ The project uses [Poetry](https://python-poetry.org/) to build the library. Clon
54
65
poetry install --all-extras
55
66
```
56
67
57
-
The ``poetry install --all-extras``command installs GQLAlchemy with all extras
58
-
(optional dependencies). Alternatively, you can use the ``-E`` option to define
68
+
The `poetry install --all-extras`command installs GQLAlchemy with all extras
69
+
(optional dependencies). Alternatively, you can use the `-E` option to define
59
70
what extras to install:
60
71
61
72
```bash
@@ -81,6 +92,7 @@ poetry run pytest . -k "arrow"
81
92
poetry run pytest . -k "dgl"
82
93
poetry run pytest . -k "docker"
83
94
```
95
+
84
96
## Development (how to build)
85
97
86
98
```bash
@@ -94,12 +106,14 @@ poetry run pytest . -k "not slow and not extras"
94
106
The GQLAlchemy documentation is available on [GitHub](https://memgraph.github.io/gqlalchemy/).
95
107
96
108
The reference guide can be generated from the code by executing:
109
+
97
110
```
98
111
pip3 install pydoc-markdown
99
112
pydoc-markdown
100
113
```
101
114
102
115
Other parts of the documentation are written and located at docs directory. To test the documentation locally execute:
Copy file name to clipboardExpand all lines: docs/changelog.md
+28-7Lines changed: 28 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,29 @@
1
1
# Changelog
2
2
3
+
## v1.5.0 - September 22, 2023
4
+
5
+
### Features and improvements
6
+
7
+
- Added `get_or_create()` metod for `Node` and `Relationship` to simplify merging nodes and relationships (https://github.com/memgraph/gqlalchemy/pull/244)
- Bumped `pydantic` to v2 (https://github.com/memgraph/gqlalchemy/pull/278)
21
+
22
+
**Special thanks to all our outside contributors for their efforts!** 👏
23
+
24
+
!!! note
25
+
We are hoping to have full support for Python 3.11 soon. Please [open an issue](https://github.com/memgraph/gqlalchemy/issues) if you have any blockers with the current update.
26
+
3
27
## v1.4.1 - April 19, 2023
4
28
5
29
### Features and improvements
@@ -40,8 +64,8 @@
40
64
- Updated all dependencies [#194](https://github.com/memgraph/gqlalchemy/pull/194)
41
65
42
66
## v1.3 - Jun 14, 2022
43
-
!!! warning
44
-
### Breaking Changes
67
+
68
+
!!! warning ### Breaking Changes
45
69
46
70
- Renamed keyword argument `edge_label` to `relationship_type` in `to()` and `from()` methods in the query builder. [#145](https://github.com/memgraph/gqlalchemy/pull/145)
47
71
@@ -54,7 +78,7 @@
54
78
- Added `foreach()` method to the query builder. [#135](https://github.com/memgraph/gqlalchemy/pull/135)
55
79
- Added `load_csv()` and `return()` methods from the query builder to base classes list. [#139](https://github.com/memgraph/gqlalchemy/pull/139)
56
80
- Added new argument types in `return_()`, `yield_()` and `with_()` methods in the query builder. [#146](https://github.com/memgraph/gqlalchemy/pull/146)
57
-
- Added `IntegratedAlgorithm` class instance as argument in `to()` and `from()` methods in the query builder. [#141](https://github.com/memgraph/gqlalchemy/pull/141)
81
+
- Added `IntegratedAlgorithm` class instance as argument in `to()` and `from()` methods in the query builder. [#141](https://github.com/memgraph/gqlalchemy/pull/141)
58
82
- Extended `IntegratedAlgorithm` class with the Breadth-first search algorithm. [#142](https://github.com/memgraph/gqlalchemy/pull/142)
59
83
- Extended `IntegratedAlgorithm` class with the Weighted shortest path algorithm. [#143](https://github.com/memgraph/gqlalchemy/pull/143)
60
84
- Extended `IntegratedAlgorithm` class with the Depth-first search algorithm. [#144](https://github.com/memgraph/gqlalchemy/pull/144)
@@ -71,17 +95,14 @@
71
95
- Added `Operator` enum which can be used as `operator` value in `set_()` and `where()` methods in the query builder. [#165](https://github.com/memgraph/gqlalchemy/pull/165)
72
96
- Added an extension to the `QueryBuilder` class to support and autocomplete integrated and MAGE query modules. [#168](https://github.com/memgraph/gqlalchemy/pull/168)
73
97
74
-
75
98
### Bug fixes
76
99
77
100
- Fixed the unbound variable error in the return statement of the Cypher query in `memgraph.save_relationship_with_id()`. [#166](https://github.com/memgraph/gqlalchemy/pull/166)
78
101
- Fixed checking if `None` for `Optional` properties. [#167](https://github.com/memgraph/gqlalchemy/pull/167)
79
102
80
-
81
103
## v1.2 - Apr 12, 2022
82
104
83
-
!!! warning
84
-
### Breaking Changes
105
+
!!! warning ### Breaking Changes
85
106
86
107
- Ordering query results as in GQLAlchemy older than 1.2 will not be possible.
87
108
- `where()`, `and_where()` and `or_where()` methods can't be used as in
Copy file name to clipboardExpand all lines: docs/installation.md
+16-9Lines changed: 16 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ as pip and Poetry, and by building it from source.
7
7
8
8
To install GQLAlchemy, you will need the following:
9
9
10
-
-**Python 3.8 - 3.10**
11
-
-GQLAlchemy is built on top of Memgraph's low-level Python client `pymgclient`, so you need to install `pymgclient`[build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites).
10
+
-**Python 3.8 - 3.11**
11
+
-`pymgclient`[build prerequisites](https://memgraph.github.io/pymgclient/introduction.html#build-prerequisites): GQLAlchemy is built on top of Memgraph's low-level Python client `pymgclient`
12
12
13
-
!!! danger
14
-
GQLAlchemy can't be installed with Python 3.11 [(#203)](https://github.com/memgraph/gqlalchemy/issues/203) and on Windows with Python >= 3.10 [(#179)](https://github.com/memgraph/gqlalchemy/issues/179). If this is currently a blocker for you, please let us know by commenting on opened issues.
13
+
!!! danger
14
+
Python 3.11 users: On Windows, GQLAlchemy is not yet compatible with this Python version. Linux users can install GQLAlchemy **without** the DGL extra (due to its dependencies not supporting Python 3.11 yet). If this is currently a blocker for you, please let us know by [opening an issue](https://github.com/memgraph/gqlalchemy/issues).
15
15
16
-
## Install with pip {#pip}
16
+
## Install with pip
17
17
18
18
After you’ve installed the prerequisites, run the following command to install
19
19
GQLAlchemy:
@@ -34,13 +34,20 @@ pip install gqlalchemy[docker] # Docker support
34
34
pip install gqlalchemy[all] # All of the above
35
35
```
36
36
37
-
!!! note
38
-
If you are using the zsh terminal, surround `gqlalchemy[$extras)]` with quotes:
37
+
!!! note
38
+
If you are using the zsh terminal, surround `gqlalchemy[$extras)]` with quotes:
39
39
40
40
```bash
41
41
pip install 'gqlalchemy[arrow]'
42
42
```
43
43
44
+
If you intend to use GQLAlchemy with PyTorch Geometric support, that library must be installed manually:
Clone or download the [GQLAlchemy source code](https://github.com/memgraph/gqlalchemy) locally and run the following command to build it from source with Poetry:
@@ -49,8 +56,8 @@ Clone or download the [GQLAlchemy source code](https://github.com/memgraph/gqlal
49
56
poetry install --all-extras
50
57
```
51
58
52
-
The ``poetry install --all-extras`` command installs GQLAlchemy with all extras
53
-
(optional dependencies). Alternatively, you can use the ``-E`` option to define
59
+
The `poetry install --all-extras`command installs GQLAlchemy with all extras
60
+
(optional dependencies). Alternatively, you can use the `-E` option to define
0 commit comments