Merge pull request #160 from maxmind/greg/eng-841-easy-way-to-serialize-python-minfraud-model-objects-to-json

Refactor model classes and provide to_dict method

Author: horgh

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     strategy:
       matrix:
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        python-version: [3.8, 3.9, "3.10", 3.11, 3.12, 3.13]
+        python-version: [3.9, "3.10", 3.11, 3.12, 3.13]
 
     name: Python ${{ matrix.python-version }} on ${{ matrix.platform }}
     runs-on: ${{ matrix.platform }}

HISTORY.rst

@@ -3,9 +3,22 @@
 History
 -------
 
-2.12.0
+3.0.0
 +++++++++++++++++++
 
+* BREAKING CHANGE: The ``minfraud.model.*`` classes have been refactored to
+  simplify them and make them more flexible. They are no longer subclass
+  NamedTuple and are now standard Python classes. This also means the
+  classes are no longer immutable. For most users, these differences should
+  not impact their integration.
+* BREAKING CHANGE: Model attributes that were formerly tuples are now lists.
+* BREAKING CHANGE: The deprecated `is_high_risk` attribute on
+  `resp.ip_address.country` has been removed.
+* IMPORTANT: Python 3.9 or greater is required. If you are using an older
+  version, please use an earlier release.
+* Added ``to_dict`` methods to the model classes. These return a dict version
+  of the object that is suitable for serialization. It recursively calls
+  ``to_dict`` or the equivalent on all objects contained within the object.
 * The minFraud Factors subscores have been deprecated. They will be removed
   in March 2025. Please see `our release notes <https://dev.maxmind.com/minfraud/release-notes/2024/#deprecation-of-risk-factor-scoressubscores>`_
   for more information.

README.rst

@@ -307,7 +307,7 @@ For asynchronous reporting:
 Requirements
 ------------
 
-Python 3.8 or greater is required. Older versions are not supported.
+Python 3.9 or greater is required. Older versions are not supported.
 
 Versioning
 ----------
@@ -327,6 +327,6 @@ for assistance.
 Copyright and License
 ---------------------
 
-This software is Copyright © 2015-2024 by MaxMind, Inc.
+This software is Copyright © 2015-2025 by MaxMind, Inc.
 
 This is free software, licensed under the Apache License, Version 2.0.

docs/conf.py

@@ -46,7 +46,7 @@
 
 # General information about the project.
 project = "minfraud"
-copyright = "2015-2024, MaxMind, Inc"
+copyright = "2015-2025, 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

@@ -31,6 +31,6 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
-:copyright: © 2015-2024 by MaxMind, Inc.
+:copyright: © 2015-2025 by MaxMind, Inc.
 :license: Apache License, Version 2.0