Merge pull request #151 from maxmind/horgh/sandbox

Document using the sandbox

Author: faktas2

LICENSE

@@ -1,7 +1,7 @@
 
                                  Apache License
                            Version 2.0, January 2004
-                        http://www.apache.org/licenses/
+                        https://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
@@ -193,7 +193,7 @@
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at
 
-       http://www.apache.org/licenses/LICENSE-2.0
+       https://www.apache.org/licenses/LICENSE-2.0
 
    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,

README.rst

@@ -7,7 +7,7 @@ Description
 
 This package provides an API for the GeoIP2 and GeoLite2 `web services
 <https://dev.maxmind.com/geoip/docs/web-services?lang=en>`_ and `databases
-<https://dev.maxmind.com/geoip/docs/databases?lang=en>`_. 
+<https://dev.maxmind.com/geoip/docs/databases?lang=en>`_.
 
 Installation
 ------------
@@ -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
@@ -456,7 +462,7 @@ attribute in the ``geoip2.records.Traits`` record.
 Integration with GeoNames
 -------------------------
 
-`GeoNames <http://www.geonames.org/>`_ offers web services and downloadable
+`GeoNames <https://www.geonames.org/>`_ offers web services and downloadable
 databases with data on geographical features around the world, including
 populated places. They offer both free and paid premium data. Each feature is
 uniquely identified by a ``geoname_id``, which is an integer.
@@ -473,31 +479,31 @@ Reporting Data Problems
 -----------------------
 
 If the problem you find is that an IP address is incorrectly mapped, please
-`submit your correction to MaxMind <http://www.maxmind.com/en/correction>`_.
+`submit your correction to MaxMind <https://www.maxmind.com/en/correction>`_.
 
 If you find some other sort of mistake, like an incorrect spelling, please
-check the `GeoNames site <http://www.geonames.org/>`_ first. Once you've
+check the `GeoNames site <https://www.geonames.org/>`_ first. Once you've
 searched for a place and found it on the GeoNames map view, there are a
 number of links you can use to correct data ("move", "edit", "alternate
 names", etc.). Once the correction is part of the GeoNames data set, it
 will be automatically incorporated into future MaxMind releases.
 
 If you are a paying MaxMind customer and you're not sure where to submit a
 correction, please `contact MaxMind support
-<http://www.maxmind.com/en/support>`_ for help.
+<https://www.maxmind.com/en/support>`_ for help.
 
 Requirements
 ------------
 
 Python 3.7 or greater is required. Older versions are not supported.
 
 The Requests HTTP library is also required. See
-<http://python-requests.org> for details.
+<https://pypi.org/project/requests/> for details.
 
 Versioning
 ----------
 
-The GeoIP2 Python API uses `Semantic Versioning <http://semver.org/>`_.
+The GeoIP2 Python API uses `Semantic Versioning <https://semver.org/>`_.
 
 Support
 -------
@@ -507,4 +513,4 @@ Please report all issues with this code using the `GitHub issue tracker
 
 If you are having an issue with a MaxMind service that is not specific to the
 client API, please contact `MaxMind support
-<http://www.maxmind.com/en/support>`_ for assistance.
+<https://www.maxmind.com/en/support>`_ for assistance.

docs/conf.py

@@ -49,7 +49,7 @@
 
 # General information about the project.
 project = "geoip2"
-copyright = "2013-2022, MaxMind, Inc."
+copyright = "2013-2023, MaxMind, Inc."
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

docs/index.rst

@@ -38,6 +38,6 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-:copyright: (c) 2013-2022 by MaxMind, Inc.
+:copyright: (c) 2013-2023 by MaxMind, Inc.
 :license: Apache License, Version 2.0
 

geoip2/__init__.py

@@ -4,4 +4,4 @@
 __version__ = "4.7.0"
 __author__ = "Gregory Oschwald"
 __license__ = "Apache License, Version 2.0"
-__copyright__ = "Copyright (c) 2013-2022 Maxmind, Inc."
+__copyright__ = "Copyright (c) 2013-2023 MaxMind, Inc."

geoip2/records.py

@@ -188,7 +188,7 @@ class Country(PlaceRecord):
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
-      <http://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the
+      <https://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the
       country.
 
       :type: str
@@ -264,7 +264,7 @@ class RepresentedCountry(Country):
     .. attribute:: iso_code
 
       The two-character `ISO 3166-1
-      <http://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the country.
+      <https://en.wikipedia.org/wiki/ISO_3166-1>`_ alpha code for the country.
 
       :type: str
 
@@ -373,7 +373,7 @@ class Location(Record):
     .. attribute:: time_zone
 
       The time zone associated with location, as specified by the `IANA Time
-      Zone Database <http://www.iana.org/time-zones>`_, e.g.,
+      Zone Database <https://www.iana.org/time-zones>`_, e.g.,
       "America/New_York".
 
       :type: str
@@ -492,7 +492,7 @@ class Subdivision(PlaceRecord):
 
       This is a string up to three characters long
       contain the subdivision portion of the `ISO 3166-2 code
-      <http://en.wikipedia.org/wiki/ISO_3166-2>`_.
+      <https://en.wikipedia.org/wiki/ISO_3166-2>`_.
 
       :type: str
 
@@ -582,7 +582,7 @@ class Traits(Record):
     .. attribute:: autonomous_system_number
 
       The `autonomous system
-      number <http://en.wikipedia.org/wiki/Autonomous_system_(Internet)>`_
+      number <https://en.wikipedia.org/wiki/Autonomous_system_(Internet)>`_
       associated with the IP address. This attribute is only available from
       the City Plus and Insights web services and the Enterprise database.
 
@@ -591,7 +591,7 @@ class Traits(Record):
     .. attribute:: autonomous_system_organization
 
       The organization associated with the registered `autonomous system
-      number <http://en.wikipedia.org/wiki/Autonomous_system_(Internet)>`_ for
+      number <https://en.wikipedia.org/wiki/Autonomous_system_(Internet)>`_ for
       the IP address. This attribute is only available from the City Plus and
       Insights web service end points and the Enterprise database.
 

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'].

setup.cfg

@@ -4,7 +4,7 @@ author = Gregory Oschwald
 author_email = [email protected]
 license = Apache License, Version 2.0
 description = MaxMind GeoIP2 API
-url = http://www.maxmind.com/
+url = https://www.maxmind.com/
 long_description = file: README.rst
 classifiers =
     Development Status :: 5 - Production/Stable