Add documentation and doctest

Author: maltehedderich

testcontainers/minio.py

@@ -6,6 +6,32 @@
 
 
 class MinioContainer(DockerContainer):
+    """
+    The example below spins up an Minio container and creates a new bucket in it.
+    Furthermore, it demonstrates how an object is written to this bucket and then subsequently retrieved.
+    The method :code:`get_client` can be used to create a client for the Minio Python API.
+    The method :code:`get_config` can be used to retrieve the endpoint, access key
+    and secret key of the container.
+
+    Example
+    -------
+    .. doctest::
+
+        >>> from testcontainers.minio import MinioContainer
+
+        >>> with MinioContainer() as minio:
+        ...   client = minio.get_client()
+        ...   client.make_bucket("test")
+        ...   test_content = b"Hello World"
+        ...   client.put_object(
+        ...       "test",
+        ...       "testfile.txt",
+        ...       io.BytesIO(test_content),
+        ...       length=len(test_content),
+        ...   )
+        ...   retrieved_content = client.get_object("test", "testfile.txt").data
+    """
+
     def __init__(
         self,
         image="minio/minio:RELEASE.2022-12-02T19-19-22Z",
@@ -14,6 +40,14 @@ def __init__(
         secret_key="minioadmin",
         **kwargs,
     ):
+        """
+        Args:
+            image (str, optional): The Docker image to use for the Minio container.
+                                   Defaults to "minio/minio:RELEASE.2022-12-02T19-19-22Z".
+            port_to_expose (int, optional): The port to expose on the container. Defaults to 9000.
+            access_key (str, optional): The access key for client connections. Defaults to "minioadmin".
+            secret_key (str, optional): The secret key for client connections. Defaults to "minioadmin".
+        """
         super(MinioContainer, self).__init__(image, **kwargs)
         self.port_to_expose = port_to_expose
         self.access_key = access_key
@@ -42,7 +76,8 @@ def get_client(self, **kwargs) -> Minio:
         )
 
     def get_config(self) -> dict:
-        """Returns the configuration of the Minio container.
+        """This method returns the configuration of the Minio container,
+        including the endpoint, access key, and secret key.
 
         Returns:
             dict: {`endpoint`: str, `access_key`: str, `secret_key`: str}
@@ -57,11 +92,15 @@ def get_config(self) -> dict:
 
     @wait_container_is_ready(ConnectionError)
     def _healthcheck(self):
+        """This is an internal method used to check if the Minio container
+        is healthy and ready to receive requests."""
         url = f"http://{self.get_config()['endpoint']}/minio/health/live"
         response: Response = get(url)
         response.raise_for_status()
 
     def start(self):
+        """This method starts the Minio container and runs the healthcheck
+        to verify that the container is ready to use."""
         super().start()
         self._healthcheck()
         return self