feat: set UserAgent version to 0.0.0-dev when developing

Author: HungKNguyen

.env.example

@@ -1,3 +1,7 @@
 # Nutrient DWS Processor API Configuration for Testing
 NUTRIENT_API_KEY=your_api_key_here
 NUTRIENT_BASE_URL=https://api.nutrient.io
+
+# Development Settings
+DEBUG=true
+PYTHON_ENV=development

examples/.env.example

@@ -1 +1,2 @@
 NUTRIENT_API_KEY=your_api_key_here
+PYTHON_ENV=development

src/nutrient_dws/client.py

@@ -152,7 +152,7 @@ def _validate_options(self, options: NutrientClientOptions) -> None:
             raise ValidationError("API key is required")
 
         api_key = options["apiKey"]
-        if not isinstance(api_key, (str, type(lambda: None))):
+        if not (isinstance(api_key, str) or callable(api_key)):
             raise ValidationError(
                 "API key must be a string or a function that returns a string"
             )

src/nutrient_dws/inputs.py

@@ -33,8 +33,7 @@ def is_url(string: str) -> bool:
 
 def is_valid_pdf(file_bytes: bytes) -> bool:
     """Check if a file is a valid PDF."""
-    pdf_header = file_bytes[:5].decode("ascii")
-    return pdf_header == "%PDF-"
+    return file_bytes.startswith(b"%PDF-")
 
 
 def is_remote_file_input(file_input: FileInput) -> TypeGuard[str]:

src/nutrient_dws/utils/version.py

@@ -1,17 +1,21 @@
-from importlib.metadata import PackageNotFoundError, version
+import os
+from importlib.metadata import version as pkg_version
 
 
 def get_library_version() -> str:
-    """Gets the current version of the Nutrient DWS Python Client library."""
-    try:
-        return version("nutrient-dws")
-    except PackageNotFoundError:
-        # fallback for when running from source (not installed yet)
-        from importlib.metadata import metadata
+    """Gets the current version of the Nutrient DWS Python Client library.
 
-        return metadata("nutrient-dws")["Version"]
+    Strategy: Try importlib.metadata.version("nutrient-dws"); on any failure, return "0.0.0-dev".
+    """
+    if os.getenv("PYTHON_ENV") == "development":
+        return "0.0.0-dev"
+    try:
+        return pkg_version("nutrient-dws")
+    except Exception:
+        return "0.0.0-dev"
 
 
 def get_user_agent() -> str:
     """Creates a User-Agent string for HTTP requests."""
-    return f"nutrient-dws/{get_library_version()}"
+    package_version = get_library_version()
+    return f"nutrient-dws/{package_version}"

tests/conftest.py

@@ -1,13 +1,9 @@
-import os
 from unittest.mock import AsyncMock
 
 import pytest
-from dotenv import load_dotenv
 from nutrient_dws import NutrientClient
 from tests.helpers import TestDocumentGenerator
 
-load_dotenv()  # Load environment variables
-
 @pytest.fixture
 def mock_workflow_instance():
     """Create a mock workflow instance for testing."""
@@ -50,12 +46,6 @@ def valid_client_options():
 def unit_client():
     return NutrientClient(api_key="test-api-key", base_url="https://api.test.com/v1")
 
-@pytest.fixture(scope="class")
-def integration_client():
-    """Create client instance for testing."""
-    return NutrientClient(api_key=os.getenv("NUTRIENT_API_KEY", ""), base_url=os.getenv("NUTRIENT_BASE_URL", "https://api.nutrient.io"))
-
-
 @pytest.fixture
 def test_table_pdf():
     """Generate PDF with table for annotation tests."""

tests/test_integration.py

@@ -34,6 +34,11 @@
     reason="Integration tests require NUTRIENT_API_KEY environment variable",
 )
 
+@pytest.fixture(scope="class")
+def integration_client():
+    """Create client instance for testing."""
+    return NutrientClient(api_key=os.getenv("NUTRIENT_API_KEY", ""), base_url=os.getenv("NUTRIENT_BASE_URL", "https://api.nutrient.io"))
+
 
 class TestIntegrationDirectMethods:
     """Integration tests with live API - direct client methods."""
@@ -165,7 +170,7 @@ async def test_convert_formats(
         if output_type not in ["markdown", "html"]:
             assert isinstance(result.get("buffer"), (bytes, bytearray))
         else:
-            assert isinstance(result.get("content"), bytes)
+            assert isinstance(result.get("content"), str)
         assert result["mimeType"] == expected_mime
 
     @pytest.mark.asyncio

tests/unit/test_builder.py

@@ -840,7 +840,7 @@ async def mock_request(endpoint, data):
                         assert result["success"] is True
                         assert (
                             result["output"]["content"]
-                            == b"<html><body>Content</body></html>"
+                            == "<html><body>Content</body></html>"
                         )
                         assert result["output"]["mimeType"] == "text/html"
                         assert result["output"]["filename"] == "output.html"
@@ -873,7 +873,7 @@ async def mock_request(endpoint, data):
                         result = await builder.execute()
 
                         assert result["success"] is True
-                        assert result["output"]["content"] == b"# Header\n\nContent"
+                        assert result["output"]["content"] == "# Header\n\nContent"
                         assert result["output"]["mimeType"] == "text/markdown"
                         assert result["output"]["filename"] == "output.md"
 

tests/unit/test_http.py

@@ -178,7 +178,7 @@ async def test_successful_get_request(self):
             assert call_kwargs["method"] == "GET"
             assert call_kwargs["url"] == "https://api.test.com/v1/account/info"
             assert call_kwargs["headers"]["Authorization"] == "Bearer test-api-key"
-            assert re.match(r'^nutrient-dws/\d+\.\d+\.\d+', call_kwargs["headers"]["User-Agent"])
+            assert re.match(r'^nutrient-dws/\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?', call_kwargs["headers"]["User-Agent"])
             assert call_kwargs["timeout"] is None
 
             assert result["data"] == {"result": "success"}

tests/unit/test_utils.py

@@ -1,3 +1,6 @@
+import os
+from unittest import mock
+
 import pytest
 import re
 from nutrient_dws.utils import (
@@ -46,6 +49,21 @@ def test_get_user_agent_follows_expected_format(self):
         expected_pattern = r'^nutrient-dws/\d+\.\d+\.\d+(?:-[a-zA-Z0-9.-]+)?$'
         assert re.match(expected_pattern, user_agent)
 
+    @mock.patch.dict(
+        os.environ,
+        {
+            "PYTHON_ENV": "development",
+        },
+        clear=True,
+    )
+    def test_get_user_agent_follows_expected_format_development(self):
+        """Should follow the expected User-Agent format in development"""
+        user_agent = get_user_agent()
+
+        # Should match: nutrient-dws/VERSION
+        assert user_agent == "nutrient-dws/0.0.0-dev"
+
+
     def test_get_user_agent_includes_correct_library_name(self):
         """Should include the correct library name"""
         user_agent = get_user_agent()