Merge pull request #120 from maxmind/fatih/sandbox-info

Add info on the Sandbox env
maxmind · Aug 14, 2023 · 43766c0 · 43766c0
2 parents f5fbc7a + c432afe
commit 43766c0
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -44,6 +44,14 @@ constructors take your MaxMind account ID and license key:
     >>> client = Client(42, 'licensekey')
     >>> async_client = AsyncClient(42, 'licensekey')
 
+To use the Sandbox web service instead of the production web service,
+you can provide the host argument:
+
+.. code-block:: pycon
+
+    >>> client = Client(42, 'licensekey', 'sandbox.maxmind.com')
+    >>> async_client = AsyncClient(42, 'licensekey', 'sandbox.maxmind.com')
+
 Score, Insights and Factors Usage
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 

diff --git a/minfraud/webservice.py b/minfraud/webservice.py
@@ -455,6 +455,11 @@ def __init__(
         :param license_key: Your MaxMind license key
         :type license_key: str
         :param host: The host to use when connecting to the web service.
+          By default, the client connects to the production host. However,
+          during testing and development, you can set this option to
+          'sandbox.maxmind.com' to use the Sandbox environment's host. The
+          sandbox allows you to experiment with the API without affecting your
+          production data.
         :type host: str
         :param locales: A tuple of locale codes to use in name property
         :type locales: tuple[str]