chore: Pypi tests and handy make commands

Author: n0nSmoker

.gitignore

@@ -1,5 +1,6 @@
 dist
 env
+.env
 
 .idea
 __MACOSX

Makefile

@@ -1,9 +1,16 @@
-.PHONY: test format
+.PHONY: test format test-pypi
 FILE = $(file)
 
 test:
 	TEST_FILE=$(FILE) docker-compose up --build --abort-on-container-exit
 
+test-pypi:
+	uv run pytest -xvrs --color=yes -m pypi tests/test_pypi_readiness.py::test_pypi_version_can_be_installed_and_used
+
 format:
 	uv run ruff format .
 	uv run ruff check --fix .
+
+publish:
+	uv build --no-sources
+	UV_PUBLISH_TOKEN="$(PYPI_TOKEN)" uv publish

pyproject.toml

@@ -45,8 +45,11 @@ build-backend = "setuptools.build_meta"
 include-package-data = true
 
 [tool.pytest.ini_options]
-addopts = "-xvrs --color=yes"
+addopts = "-xvrs --color=yes -m 'not pypi'"
 log_cli = true
+markers = [
+    "pypi: marks tests that require PyPI access (deselect with -m 'not pypi')",
+]
 
 
 [tool.ruff]

sqlalchemy_serializer/serializer.py

@@ -17,6 +17,11 @@
 logger = logging.getLogger("serializer")
 logger.setLevel(level="WARN")
 
+SERIALIZER_DEFAULT_DATE_FORMAT = "%Y-%m-%d"
+SERIALIZER_DEFAULT_DATETIME_FORMAT = "%Y-%m-%d %H:%M:%S"
+SERIALIZER_DEFAULT_TIME_FORMAT = "%H:%M"
+SERIALIZER_DEFAULT_DECIMAL_FORMAT = "{}"
+
 
 class SerializerMixin:
     """Mixin for retrieving public fields of sqlAlchemy-model in json-compatible format
@@ -38,10 +43,10 @@ class SerializerMixin:
     # Custom list of fields to serialize in this model
     serializable_keys: tuple = ()
 
-    date_format = "%Y-%m-%d"
-    datetime_format = "%Y-%m-%d %H:%M:%S"
-    time_format = "%H:%M"
-    decimal_format = "{}"
+    date_format = SERIALIZER_DEFAULT_DATE_FORMAT
+    datetime_format = SERIALIZER_DEFAULT_DATETIME_FORMAT
+    time_format = SERIALIZER_DEFAULT_TIME_FORMAT
+    decimal_format = SERIALIZER_DEFAULT_DECIMAL_FORMAT
 
     # Serialize fields of the model defined as @property automatically
     auto_serialize_properties: bool = False
@@ -111,7 +116,18 @@ class Serializer:
 
     def __init__(self, **kwargs):
         self.set_serialization_depth(0)
-        self.set_options(Options(**kwargs))
+        # Provide defaults for Options if not specified
+        options_kwargs = {
+            "date_format": kwargs.get("date_format", SERIALIZER_DEFAULT_DATE_FORMAT),
+            "datetime_format": kwargs.get(
+                "datetime_format", SERIALIZER_DEFAULT_DATETIME_FORMAT
+            ),
+            "time_format": kwargs.get("time_format", SERIALIZER_DEFAULT_TIME_FORMAT),
+            "decimal_format": kwargs.get("decimal_format", SERIALIZER_DEFAULT_DECIMAL_FORMAT),
+            "tzinfo": kwargs.get("tzinfo"),
+            "serialize_types": kwargs.get("serialize_types", ()),
+        }
+        self.set_options(Options(**options_kwargs))
         self.init_callbacks()
 
         self.schema = Schema()

tests/test_pypi_readiness.py

@@ -14,6 +14,7 @@
 from pathlib import Path
 
 import pytest
+import requests
 
 # Handle TOML parsing for different Python versions
 try:
@@ -220,3 +221,96 @@ def test_package_can_be_installed():
             f"STDOUT: {import_result.stdout}\n"
             f"STDERR: {import_result.stderr}"
         )
+
+
+@pytest.mark.pypi
+def test_pypi_version_can_be_installed_and_used():
+    """Test that the current version from PyPI can be installed and used."""
+    if tomllib is None:
+        pytest.skip("tomllib or tomli is required to get package name")
+
+    project_root = Path(__file__).parent.parent
+    pyproject_path = project_root / "pyproject.toml"
+
+    # Get package name from pyproject.toml
+    with open(pyproject_path, "rb") as f:
+        config = tomllib.load(f)
+
+    package_name = config.get("project", {}).get("name")
+    if not package_name:
+        pytest.skip("Package name not found in pyproject.toml")
+
+    # Query PyPI API for latest version
+    pypi_url = f"https://pypi.org/pypi/{package_name}/json"
+    try:
+        response = requests.get(pypi_url, timeout=10)
+        response.raise_for_status()
+        pypi_data = response.json()
+    except requests.RequestException as e:
+        pytest.skip(f"Failed to query PyPI: {e}")
+
+    # Get the latest version
+    latest_version = pypi_data.get("info", {}).get("version")
+    if not latest_version:
+        pytest.skip("No version found in PyPI response")
+
+    # Create a temporary virtual environment
+    with tempfile.TemporaryDirectory() as tmpdir:
+        venv_path = Path(tmpdir) / "test_venv"
+
+        # Create virtual environment
+        subprocess.run(
+            [sys.executable, "-m", "venv", str(venv_path)],
+            check=True,
+            capture_output=True,
+        )
+
+        # Get pip path
+        if sys.platform == "win32":
+            pip_path = venv_path / "Scripts" / "pip"
+            python_path = venv_path / "Scripts" / "python"
+        else:
+            pip_path = venv_path / "bin" / "pip"
+            python_path = venv_path / "bin" / "python"
+
+        # Install the package from PyPI
+        install_result = subprocess.run(
+            [str(pip_path), "install", f"{package_name}=={latest_version}"],
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+
+        assert install_result.returncode == 0, (
+            f"PyPI package installation failed.\n"
+            f"STDOUT: {install_result.stdout}\n"
+            f"STDERR: {install_result.stderr}"
+        )
+
+        # Verify package can be imported
+        import_test_code = """
+import sqlalchemy_serializer
+from sqlalchemy_serializer import SerializerMixin, Serializer
+
+# Test basic import
+assert hasattr(sqlalchemy_serializer, 'SerializerMixin')
+assert hasattr(sqlalchemy_serializer, 'Serializer')
+
+# Test Serializer can be instantiated
+serializer = Serializer()
+assert serializer is not None
+
+print('OK')
+"""
+        import_result = subprocess.run(
+            [str(python_path), "-c", import_test_code],
+            capture_output=True,
+            text=True,
+            check=False,
+        )
+
+        assert import_result.returncode == 0, (
+            f"Package usage test failed after PyPI installation.\n"
+            f"STDOUT: {import_result.stdout}\n"
+            f"STDERR: {import_result.stderr}"
+        )