Document using the sandbox

Author: horgh

README.rst

@@ -47,7 +47,9 @@ To use this API, you first construct either a ``geoip2.webservice.Client`` or
 ``geoip2.webservice.AsyncClient``, passing your MaxMind ``account_id`` and
 ``license_key`` to the constructor. To use the GeoLite2 web service instead of
 the GeoIP2 web service, set the optional ``host`` keyword argument to
-``geolite.info``.
+``geolite.info``. To use the Sandbox GeoIP2 web service instead of the
+production GeoIP2 web service, set the optional ``host`` keyword argument to
+``sandbox.maxmind.com``.
 
 After doing this, you may call the method corresponding to request type
 (e.g., ``city`` or ``country``), passing it the IP address you want to look up.
@@ -68,7 +70,9 @@ Sync Web Service Example
     >>> # This creates a Client object that can be reused across requests.
     >>> # Replace "42" with your account ID and "license_key" with your license
     >>> # key. Set the "host" keyword argument to "geolite.info" to use the
-    >>> # GeoLite2 web service instead of the GeoIP2 web service.
+    >>> # GeoLite2 web service instead of the GeoIP2 web service. Set the
+    >>> # "host" keyword argument to "sandbox.maxmind.com" to use the Sandbox
+    >>> # GeoIP2 web service instead of the production GeoIP2 web service.
     >>> with geoip2.webservice.Client(42, 'license_key') as client:
     >>>
     >>>     # Replace "city" with the method corresponding to the web service
@@ -118,7 +122,9 @@ Async Web Service Example
     >>>     #
     >>>     # Replace "42" with your account ID and "license_key" with your license
     >>>     # key. Set the "host" keyword argument to "geolite.info" to use the
-    >>>     # GeoLite2 web service instead of the GeoIP2 web service.
+    >>>     # GeoLite2 web service instead of the GeoIP2 web service. Set the
+    >>>     # "host" keyword argument to "sandbox.maxmind.com" to use the Sandbox
+    >>>     # GeoIP2 web service instead of the production GeoIP2 web service.
     >>>     async with geoip2.webservice.AsyncClient(42, 'license_key') as client:
     >>>
     >>>         # Replace "city" with the method corresponding to the web service

geoip2/webservice.py

@@ -220,7 +220,10 @@ class AsyncClient(BaseClient):
 
     :param host: The hostname to make a request against. This defaults to
       "geoip.maxmind.com". To use the GeoLite2 web service instead of the
-      GeoIP2 web service, set this to "geolite.info".
+      GeoIP2 web service, set this to "geolite.info". To use the Sandbox
+      GeoIP2 web service instead of the production GeoIP2 web service, set
+      this to "sandbox.maxmind.com". The sandbox allows you to experiment
+      with the API without affecting your production data.
     :param locales: This is list of locale codes. This argument will be
       passed on to record classes to use when their name properties are
       called. The default value is ['en'].
@@ -379,7 +382,10 @@ class Client(BaseClient):
 
     :param host: The hostname to make a request against. This defaults to
       "geoip.maxmind.com". To use the GeoLite2 web service instead of the
-      GeoIP2 web service, set this to "geolite.info".
+      GeoIP2 web service, set this to "geolite.info". To use the Sandbox
+      GeoIP2 web service instead of the production GeoIP2 web service, set
+      this to "sandbox.maxmind.com". The sandbox allows you to experiment
+      with the API without affecting your production data.
     :param locales: This is list of locale codes. This argument will be
       passed on to record classes to use when their name properties are
       called. The default value is ['en'].