Update README and refactor model fields for improved clarity and compatibility (#305)

- Updated README to reflect new Python and Django version requirements (Python >= 3.10, Django >= 4.2).
- Added instructions for generating translations in the README.
- Refactored model fields in abstract_models.py to include verbose names for better clarity in the admin interface.
- Created a new migration to apply changes to the database schema, ensuring consistency with updated model definitions.

Author: marianoeramirez

README.rst

@@ -27,14 +27,10 @@ database, you should use
 
 Requirements:
 
-- Python >= 3.8
-- Django >= 3.2
+- Python >= 3.10
+- Django >= 4.2
 - MySQL or PostgreSQL or SQLite.
 
-Yes, for some reason, code that used to work on MySQL (not without pain xD)
-does not work anymore. So we're now using django.db.transaction.atomic which
-comes from Django 1.6 just to support MySQL quacks.
-
 Features
 --------
 - GraphQL support
@@ -169,6 +165,14 @@ To run it even faster, you can switch to specific tox virtualenv::
     CI=True py.test -v --cov cities_light --create-db --strict -r fEsxXw cities_light/tests/test_form.py::FormTestCase::testCountryFormNameAndContinentAlone
     CI=true test_project/manage.py test cities_light.tests.test_form.FormTestCase.testCountryFormNameAndContinentAlone
 
+
+If you want to generate the translations, use the following steps::
+    
+    source .tox/dev/bin/activate
+    cd src/cities_light
+    python manage.py makemessages -l fr
+    python manage.py compilemessages
+
 If you want to build the docs, use the following steps::
 
     source .tox/dev/bin/activate

src/cities_light/abstract_models.py

@@ -83,12 +83,20 @@ class Base(models.Model):
     Base model with boilerplate for all models.
     """
 
-    name = models.CharField(max_length=200, db_index=True)
-    name_ascii = models.CharField(max_length=200, blank=True, db_index=True)
-    slug = autoslug.AutoSlugField(populate_from="name_ascii")
-    geoname_id = models.IntegerField(null=True, blank=True, unique=True)
-    alternate_names = models.TextField(null=True, blank=True, default="")
-    translations = models.JSONField(default=dict, blank=True)
+    name = models.CharField(max_length=200, db_index=True, verbose_name=_("name"))
+    name_ascii = models.CharField(
+        max_length=200, blank=True, db_index=True, verbose_name=_("ASCII name")
+    )
+    slug = autoslug.AutoSlugField(populate_from="name_ascii", verbose_name=_("slug"))
+    geoname_id = models.IntegerField(
+        null=True, blank=True, unique=True, verbose_name=_("Geonames ID")
+    )
+    alternate_names = models.TextField(
+        null=True, blank=True, default="", verbose_name=_("alternate names")
+    )
+    translations = models.JSONField(
+        default=dict, blank=True, verbose_name=_("translations")
+    )
 
     objects = BaseManager()
 
@@ -111,11 +119,32 @@ class AbstractCountry(Base):
     Base Country model.
     """
 
-    code2 = models.CharField(max_length=2, null=True, blank=True, unique=True)
-    code3 = models.CharField(max_length=3, null=True, blank=True, unique=True)
-    continent = models.CharField(max_length=2, db_index=True, choices=CONTINENT_CHOICES)
-    tld = models.CharField(max_length=5, blank=True, db_index=True)
-    phone = models.CharField(max_length=20, null=True, blank=True)
+    code2 = models.CharField(
+        max_length=2,
+        null=True,
+        blank=True,
+        unique=True,
+        verbose_name=_("ISO 3166-1 alpha-2"),
+    )
+    code3 = models.CharField(
+        max_length=3,
+        null=True,
+        blank=True,
+        unique=True,
+        verbose_name=_("ISO 3166-1 alpha-3"),
+    )
+    continent = models.CharField(
+        max_length=2,
+        db_index=True,
+        choices=CONTINENT_CHOICES,
+        verbose_name=_("continent"),
+    )
+    tld = models.CharField(
+        max_length=5, blank=True, db_index=True, verbose_name=_("top-level domain")
+    )
+    phone = models.CharField(
+        max_length=20, null=True, blank=True, verbose_name=_("phone code")
+    )
 
     class Meta(Base.Meta):
         verbose_name_plural = _("countries")
@@ -127,11 +156,19 @@ class AbstractRegion(Base):
     Base Region/State model.
     """
 
-    display_name = models.CharField(max_length=200)
-    geoname_code = models.CharField(max_length=50, null=True, blank=True, db_index=True)
+    display_name = models.CharField(max_length=200, verbose_name=_("display name"))
+    geoname_code = models.CharField(
+        max_length=50,
+        null=True,
+        blank=True,
+        db_index=True,
+        verbose_name=_("Geonames code"),
+    )
 
     country = models.ForeignKey(
-        CITIES_LIGHT_APP_NAME + ".Country", on_delete=models.CASCADE
+        CITIES_LIGHT_APP_NAME + ".Country",
+        on_delete=models.CASCADE,
+        verbose_name=_("country"),
     )
 
     class Meta(Base.Meta):
@@ -149,17 +186,26 @@ class AbstractSubRegion(Base):
     Base SubRegion model.
     """
 
-    display_name = models.CharField(max_length=200)
-    geoname_code = models.CharField(max_length=50, null=True, blank=True, db_index=True)
+    display_name = models.CharField(max_length=200, verbose_name=_("display name"))
+    geoname_code = models.CharField(
+        max_length=50,
+        null=True,
+        blank=True,
+        db_index=True,
+        verbose_name=_("Geonames code"),
+    )
 
     country = models.ForeignKey(
-        CITIES_LIGHT_APP_NAME + ".Country", on_delete=models.CASCADE
+        CITIES_LIGHT_APP_NAME + ".Country",
+        on_delete=models.CASCADE,
+        verbose_name=_("country"),
     )
     region = models.ForeignKey(
         CITIES_LIGHT_APP_NAME + ".Region",
         null=True,
         blank=True,
         on_delete=models.CASCADE,
+        verbose_name=_("region"),
     )
 
     class Meta(Base.Meta):
@@ -176,43 +222,68 @@ class AbstractCity(Base):
     Base City model.
     """
 
-    display_name = models.CharField(max_length=200)
+    display_name = models.CharField(max_length=200, verbose_name=_("display name"))
 
     search_names = ToSearchTextField(
-        max_length=4000, db_index=INDEX_SEARCH_NAMES, blank=True, default=""
+        max_length=4000,
+        db_index=INDEX_SEARCH_NAMES,
+        blank=True,
+        default="",
+        verbose_name=_("search names"),
     )
 
     latitude = models.DecimalField(
-        max_digits=8, decimal_places=5, null=True, blank=True
+        max_digits=8,
+        decimal_places=5,
+        null=True,
+        blank=True,
+        verbose_name=_("latitude"),
     )
 
     longitude = models.DecimalField(
-        max_digits=8, decimal_places=5, null=True, blank=True
+        max_digits=8,
+        decimal_places=5,
+        null=True,
+        blank=True,
+        verbose_name=_("longitude"),
     )
 
     subregion = models.ForeignKey(
         CITIES_LIGHT_APP_NAME + ".SubRegion",
         blank=True,
         null=True,
         on_delete=models.CASCADE,
+        verbose_name=_("subregion"),
     )
     region = models.ForeignKey(
         CITIES_LIGHT_APP_NAME + ".Region",
         blank=True,
         null=True,
         on_delete=models.CASCADE,
+        verbose_name=_("region"),
     )
     country = models.ForeignKey(
-        CITIES_LIGHT_APP_NAME + ".Country", on_delete=models.CASCADE
+        CITIES_LIGHT_APP_NAME + ".Country",
+        on_delete=models.CASCADE,
+        verbose_name=_("country"),
+    )
+    population = models.BigIntegerField(
+        null=True, blank=True, db_index=True, verbose_name=_("population")
+    )
+    feature_code = models.CharField(
+        max_length=10,
+        null=True,
+        blank=True,
+        db_index=True,
+        verbose_name=_("feature code"),
     )
-    population = models.BigIntegerField(null=True, blank=True, db_index=True)
-    feature_code = models.CharField(max_length=10, null=True, blank=True, db_index=True)
     timezone = models.CharField(
         max_length=40,
         blank=True,
         null=True,
         db_index=True,
         validators=[timezone_validator],
+        verbose_name=_("timezone"),
     )
 
     class Meta(Base.Meta):