Rename writing subpackage to serialization

homeworkprod · homeworkprod · commit 657ea442cf41 · 2025-12-11T03:59:51.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,8 @@
 
 ## 0.11.0 (unreleased)
 
+- Renamed `writing` subpackage to `serialization`.
+
 - Implemented serialization of series.
 
 - Renamed model `Links` to `PartyLinks`.
diff --git a/README.md b/README.md
@@ -42,7 +42,7 @@ To serialize a party with only the required attributes to TOML:
 from datetime import date
 
 from lanpartydb.models import Party
-from lanpartydb.writing import serialize_party
+from lanpartydb.serialization import serialize_party
 
 party = Party(
     slug='megalan-2023',
@@ -64,7 +64,7 @@ from decimal import Decimal
 from pathlib import Path
 
 from lanpartydb.models import Location, Party, PartyLinks, Resource
-from lanpartydb.writing import serialize_party
+from lanpartydb.serialization import serialize_party
 
 party = Party(
     slug='superlan-2024',
diff --git a/src/lanpartydb/serialization.py b/src/lanpartydb/serialization.py
@@ -1,8 +1,8 @@
 """
-lanpartydb.writing
-~~~~~~~~~~~~~~~~~~
+lanpartydb.serialization
+~~~~~~~~~~~~~~~~~~~~~~~~
 
-Data writing
+Object serialization to TOML
 
 :Copyright: 2024-2025 Jochen Kupperschmidt
 :License: MIT
diff --git a/tests/serialization/test_serialize_party.py b/tests/serialization/test_serialize_party.py
@@ -10,7 +10,7 @@
 import pytest
 
 from lanpartydb.models import Location, Party, PartyLinks, Resource
-from lanpartydb.writing import serialize_party
+from lanpartydb.serialization import serialize_party
 
 
 @pytest.mark.parametrize(
diff --git a/tests/serialization/test_serialize_series.py b/tests/serialization/test_serialize_series.py
@@ -8,7 +8,7 @@
 import pytest
 
 from lanpartydb.models import Series
-from lanpartydb.writing import serialize_series, serialize_series_list
+from lanpartydb.serialization import serialize_series, serialize_series_list
 
 
 def test_serialize_series_list():
