memgraph
diff --git a/‎.github/pull_request_template.md‎
Lines changed: 14 additions & 1 deletion b/‎.github/pull_request_template.md‎
Lines changed: 14 additions & 1 deletion
diff --git a/‎.github/workflows/build-and-test.yml‎
Lines changed: 5 additions & 1 deletion b/‎.github/workflows/build-and-test.yml‎
Lines changed: 5 additions & 1 deletion
diff --git a/‎docs/reference/gqlalchemy/connection.md‎
Lines changed: 0 additions & 77 deletions b/‎docs/reference/gqlalchemy/connection.md‎
Lines changed: 0 additions & 77 deletions
diff --git a/‎docs/reference/gqlalchemy/disk_storage.md‎
Lines changed: 53 additions & 0 deletions b/‎docs/reference/gqlalchemy/disk_storage.md‎
Lines changed: 53 additions & 0 deletions
diff --git a/‎docs/reference/gqlalchemy/instance_runner.md‎
Lines changed: 134 additions & 0 deletions b/‎docs/reference/gqlalchemy/instance_runner.md‎
Lines changed: 134 additions & 0 deletions
@@ -4,6 +4,8 @@ Please briefly explain the changes you made here.
 
 ### Pull request type
 
+Please delete options that are not relevant.
+
 - [ ] Bugfix
 - [ ] Feature
 - [ ] Code style update (formatting, renaming)
@@ -15,7 +17,18 @@ Please briefly explain the changes you made here.
 
 ### Related issues
 
-Delete section if this PR doesn't resolve any issues. Link the issue if it does.
+Delete section if this PR doesn't resolve any issues. 
+
+Closes (link to issue)
+
+### Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have made corresponding changes to the documentation
+- [ ] My changes generate no new warnings
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] New and existing unit tests pass locally with my changes
 
 ######################################
 
 
@@ -34,6 +34,10 @@ jobs:
       - name: Run memgraph instance
         run: |
           docker run -d -p 7687:7687 memgraph/memgraph --telemetry-enabled=False
+      - name: Install Memgraph
+        run: |
+          curl -O https://download.memgraph.com/memgraph/v2.2.1/ubuntu-20.04/memgraph_2.2.1-1_amd64.deb
+          sudo dpkg -i memgraph_2.2.1-1_amd64.deb
       - name: Test project
         run: |
           poetry install
@@ -71,4 +75,4 @@ jobs:
       - name: Test project
         run: |
           poetry install
-          poetry run pytest -vvv -m "not slow"
+          poetry run pytest -vvv -m "not slow and not ubuntu and not docker"
@@ -9,6 +9,8 @@ title: gqlalchemy.disk_storage
 class OnDiskPropertyDatabase(ABC)
 ```
 
+An abstract class for implementing on-disk storage features with specific databases.
+
 #### save\_node\_property
 
 ```python
@@ -79,6 +81,15 @@ def execute_query(query: str) -> List[str]
 
 Executes an SQL query on the on disk property database.
 
+**Arguments**:
+
+- `query` - A string representing an SQL query.
+  
+
+**Returns**:
+
+  A list of strings representing the results of the query.
+
 #### drop\_database
 
 ```python
@@ -95,6 +106,12 @@ def save_node_property(node_id: int, property_name: str, property_value: str) ->
 
 Saves a node property to an on disk database.
 
+**Arguments**:
+
+- `node_id` - An integer representing the internal id of the node.
+- `property_name` - A string representing the name of the property.
+- `property_value` - A string representing the value of the property.
+
 #### load\_node\_property
 
 ```python
@@ -103,6 +120,16 @@ def load_node_property(node_id: int, property_name: str) -> Optional[str]
 
 Loads a node property from an on disk database.
 
+**Arguments**:
+
+- `node_id` - An integer representing the internal id of the node.
+- `property_name` - A string representing the name of the property.
+  
+
+**Returns**:
+
+  An optional string representing the property value.
+
 #### delete\_node\_property
 
 ```python
@@ -111,6 +138,11 @@ def delete_node_property(node_id: int, property_name: str) -> None
 
 Deletes a node property from an on disk database.
 
+**Arguments**:
+
+- `node_id` - An integer representing the internal id of the node.
+- `property_name` - A string representing the name of the property.
+
 #### save\_relationship\_property
 
 ```python
@@ -119,6 +151,12 @@ def save_relationship_property(relationship_id: int, property_name: str, propert
 
 Saves a relationship property to an on disk database.
 
+**Arguments**:
+
+- `relationship_id` - An integer representing the internal id of the relationship.
+- `property_name` - A string representing the name of the property.
+- `property_value` - A string representing the value of the property.
+
 #### load\_relationship\_property
 
 ```python
@@ -127,6 +165,16 @@ def load_relationship_property(relationship_id: int, property_name: str) -> Opti
 
 Loads a relationship property from an on disk database.
 
+**Arguments**:
+
+- `relationship_id` - An integer representing the internal id of the relationship.
+- `property_name` - A string representing the name of the property.
+  
+
+**Returns**:
+
+  An optional string representing the property value.
+
 #### delete\_relationship\_property
 
 ```python
@@ -135,3 +183,8 @@ def delete_relationship_property(relationship_id: int, property_name: str) -> No
 
 Deletes a node property from an on disk database.
 
+**Arguments**:
+
+- `relationship_id` - An integer representing the internal id of the relationship.
+- `property_name` - A string representing the name of the property.
+
@@ -0,0 +1,134 @@
+---
+sidebar_label: instance_runner
+title: gqlalchemy.instance_runner
+---
+
+#### wait\_for\_port
+
+```python
+def wait_for_port(host: str = "127.0.0.1", port: int = 7687, delay: float = 0.01, timeout: float = 5.0) -> None
+```
+
+Wait for a TCP port to become available.
+
+**Arguments**:
+
+- `host` - A string representing the IP address that is being checked.
+- `port` - A string representing the port that is being checked.
+- `delay` - A float that defines how long to wait between retries.
+- `timeout` - A float that defines how long to wait for the port.
+  
+
+**Raises**:
+
+- `TimeoutError` - Raises an error when the host and port are not accepting
+  connections after the timeout period has passed.
+
+#### wait\_for\_docker\_container
+
+```python
+def wait_for_docker_container(container: "docker.Container", delay: float = 0.01, timeout: float = 5.0) -> None
+```
+
+Wait for a Docker container to enter the status `running`.
+
+**Arguments**:
+
+- `container` - The Docker container to wait for.
+- `delay` - A float that defines how long to wait between retries.
+- `timeout` - A float that defines how long to wait for the status.
+  
+
+**Raises**:
+
+- `TimeoutError` - Raises an error when the container isn&#x27;t running after the
+  timeout period has passed.
+
+## MemgraphInstanceBinary Objects
+
+```python
+class MemgraphInstanceBinary(MemgraphInstance)
+```
+
+A class for managing Memgraph instances started from binary files on Unix
+systems.
+
+**Attributes**:
+
+- `binary_path` - A string representing the path to a Memgraph binary
+  file.
+- `user` - A string representing the user that should start the Memgraph
+  process.
+
+#### start
+
+```python
+def start(restart: bool = False) -> "Memgraph"
+```
+
+Start the Memgraph instance and return the connection object.
+
+**Attributes**:
+
+- `restart` - A bool indicating if the instance should be
+  restarted if it&#x27;s already running.
+
+#### stop
+
+```python
+def stop() -> int
+```
+
+Stop the Memgraph instance.
+
+#### is\_running
+
+```python
+def is_running() -> bool
+```
+
+Check if the Memgraph instance is still running.
+
+## MemgraphInstanceDocker Objects
+
+```python
+class MemgraphInstanceDocker(MemgraphInstance)
+```
+
+A class for managing Memgraph instances started in Docker containers.
+
+**Attributes**:
+
+- `docker_image` - An enum representing the Docker image. Values:
+  `DockerImage.MEMGRAPH` and `DockerImage.MAGE`.
+- `docker_image_tag` - A string representing the tag of the Docker image.
+
+#### start
+
+```python
+def start(restart: bool = False) -> "Memgraph"
+```
+
+Start the Memgraph instance and return the connection object.
+
+**Attributes**:
+
+- `restart` - A bool indicating if the instance should be
+  restarted if it&#x27;s already running.
+
+#### stop
+
+```python
+def stop() -> Dict
+```
+
+Stop the Memgraph instance.
+
+#### is\_running
+
+```python
+def is_running() -> bool
+```
+
+Check if the Memgraph instance is still running.
+