Update imports for readthedocs (#89)

* Add readthedocs.yml config.

* Add requirements.

* Add docs target.

* Modify imports.

* Simplify setup.

Author: tillahoffmann

.readthedocs.yml

@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - method: pip
+      path: .

Makefile

@@ -3,6 +3,7 @@ REQUIREMENTS = $(addprefix requirements/,${PYTHON_VERSIONS:=.txt})
 TESTS = $(addprefix tests/,${PYTHON_VERSIONS})
 IMAGES = $(addprefix image/,${PYTHON_VERSIONS})
 RUN = docker run --rm -it
+.PHONY : docs
 
 # Default target
 
@@ -34,3 +35,8 @@ tests : ${TESTS}
 ${TESTS} : tests/% : image/%
 	${RUN} -v /var/run/docker.sock:/var/run/docker.sock testcontainers-python:$* bash -c \
 		"flake8 && pytest -v ${ARGS}"
+
+# Target to build the documentation
+
+docs :
+	sphinx-build -nW docs docs/_build/html

docs/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

testcontainers/core/generic.py

@@ -10,7 +10,6 @@
 #    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 #    License for the specific language governing permissions and limitations
 #    under the License.
-import sqlalchemy
 
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_container_is_ready
@@ -23,6 +22,7 @@ def __init__(self, image):
 
     @wait_container_is_ready()
     def _connect(self):
+        import sqlalchemy
         engine = sqlalchemy.create_engine(self.get_connection_url())
         engine.connect()
 

testcontainers/mongodb.py

@@ -12,8 +12,6 @@
 #    under the License.
 import os
 
-from pymongo import MongoClient
-
 from testcontainers.core.generic import DockerContainer
 
 
@@ -68,5 +66,6 @@ def get_connection_url(self):
         return "mongodb://{}:{}".format(self.get_container_host_ip(), port)
 
     def get_connection_client(self):
+        from pymongo import MongoClient
         return MongoClient("mongodb://{}:{}".format(self.get_container_host_ip(),
                                                     self.get_exposed_port(self.port_to_expose)))

testcontainers/selenium.py

@@ -17,9 +17,6 @@
 Allows to spin up selenium containers for testing with browsers.
 """
 
-from selenium import webdriver
-from selenium.webdriver.remote.webdriver import WebDriver
-
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_container_is_ready
 
@@ -65,11 +62,12 @@ def _configure(self):
 
     @wait_container_is_ready()
     def _connect(self):
+        from selenium import webdriver
         return webdriver.Remote(
             command_executor=(self.get_connection_url()),
             desired_capabilities=self.capabilities)
 
-    def get_driver(self) -> WebDriver:
+    def get_driver(self):
         return self._connect()
 
     def get_connection_url(self) -> str: