Update tests for new Catalog.create() API and rename package to pyopds2 (#19)

* Add GitHub Actions workflow for linting and testing
* Fix tests and library errors for new Catalog.create() API
* Apply linting fixes for formatting and whitespace
* Rename package from opds2 to pyopds2
* run for py3.11 and 3.12

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Michael E. Karpeles (Mek) <michael.karpeles@gmail.com>

Author: Copilot

.github/workflows/test.yml

@@ -0,0 +1,39 @@
+name: Python Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.11', '3.12']
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[dev]
+        pip install flake8
+    
+    - name: Lint with flake8
+      run: |
+        # Stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # Exit-zero treats all errors as warnings
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    
+    - name: Run tests with pytest
+      run: |
+        pytest tests/ -v --cov=opds2 --cov-report=term-missing

opds2/__init__.py pyopds2/__init__.pyopds2/__init__.py renamed to pyopds2/__init__.py

@@ -6,15 +6,15 @@
 
 __version__ = "0.1.0"
 
-from opds2.models import (
+from pyopds2.models import (
     Catalog,
     Contributor,
     Link,
     Metadata,
     Navigation,
     Publication,
 )
-from opds2.provider import DataProvider, DataProviderRecord
+from pyopds2.provider import DataProvider, DataProviderRecord
 
 __all__ = [
     "Catalog",

opds2/helpers.py pyopds2/helpers.pyopds2/helpers.py renamed to pyopds2/helpers.py

@@ -1,6 +1,7 @@
 from urllib.parse import urlencode, urlparse, parse_qsl, urlunparse
 
-def build_url(base_url: str, params: dict[str, str]  | None = None) -> str:
+
+def build_url(base_url: str, params: dict[str, str] | None = None) -> str:
     if not params:
         return base_url
 
@@ -9,4 +10,4 @@ def build_url(base_url: str, params: dict[str, str]  | None = None) -> str:
     query.update(params)
     url_parts[4] = urlencode(query, doseq=True)  # doseq=True supports lists
 
-    return urlunparse(url_parts)
+    return urlunparse(url_parts)

opds2/models.py pyopds2/models.pyopds2/models.py renamed to pyopds2/models.py

@@ -5,18 +5,17 @@
 
 from datetime import datetime
 from typing import TYPE_CHECKING, Any, Dict, List, Optional
-from urllib.parse import urlencode
 
-from pydantic import BaseModel, Field # field_validator
+from pydantic import BaseModel, Field  # field_validator
 
 
 if TYPE_CHECKING:
-    from opds2.provider import DataProvider
+    from pyopds2.provider import DataProvider
 
 
 class Link(BaseModel):
     """Represents a link in OPDS 2.0.
-    
+
     Links are used to associate resources with a publication or catalog.
     """
     href: str = Field(..., description="URI or URI template of the linked resource")
@@ -42,7 +41,7 @@ class Contributor(BaseModel):
 
 class Metadata(BaseModel):
     """Metadata for a publication or catalog.
-    
+
     Contains descriptive information about the resource.
     """
     title: str = Field(..., description="Title of the resource")
@@ -65,7 +64,7 @@ class Metadata(BaseModel):
 
 class Publication(BaseModel):
     """Represents a publication in OPDS 2.0.
-    
+
     A publication is a digital work (book, audiobook, etc.) with metadata and links.
     """
     metadata: Metadata = Field(..., description="Metadata about the publication")
@@ -93,13 +92,13 @@ class Navigation(BaseModel):
 
 class Catalog(BaseModel):
     """Represents an OPDS 2.0 catalog/feed.
-    
+
     A catalog is a collection of publications with optional navigation.
     """
     metadata: Metadata = Field(..., description="Metadata about the catalog")
     links: List[Link] = Field(default_factory=list, description="Links (self, search, etc.)")
     publications: Optional[List[Publication]] = Field(
-        None, 
+        None,
         description="List of publications in this catalog"
     )
     navigation: Optional[List[Navigation]] = Field(
@@ -144,7 +143,7 @@ def model_dump_json(self, **kwargs) -> str:
         # Use model_dump to get the dict with @context, then serialize to JSON
         data = self.model_dump(**kwargs)
         return json.dumps(data, default=str)
-    
+
     def add_pagination(self, response: 'DataProvider.SearchResponse'):
         """
         Add pagination to the current Catalog based on the SearchResponse.
@@ -196,7 +195,7 @@ def add_pagination(self, response: 'DataProvider.SearchResponse'):
 
     @classmethod
     def create(
-        cls, 
+        cls,
         response: Optional['DataProvider.SearchResponse'] = None,
         paginate: bool = True,
         # Catalog properties
@@ -209,12 +208,12 @@ def create(
     ) -> 'Catalog':
         """
         Create an OPDS Catalog, optionally from search results.
-        
+
         Args:
             response: Optional SearchResponse for paginated search results
             paginate: Whether to add pagination links (requires data)
         """
-        metadata = metadata or Metadata()
+        metadata = metadata or Metadata(title="OPDS Catalog")
         links = links or []
         publications = publications or []
 
@@ -229,10 +228,16 @@ def create(
 
         if response:
             if publications:
-                raise ValueError("Cannot specify both publications and response parameters - publications are generated from the response")
-            catalog.publications = [record.to_publication() for record in response.records]
-        
-            if paginate:        
+                raise ValueError(
+                    "Cannot specify both publications and response "
+                    "parameters - publications are generated from "
+                    "the response"
+                )
+            catalog.publications = [
+                record.to_publication() for record in response.records
+            ]
+
+            if paginate:
                 catalog.add_pagination(response)
 
         return catalog

opds2/provider.py pyopds2/provider.pyopds2/provider.py renamed to pyopds2/provider.py

@@ -9,13 +9,13 @@
 from typing import List, Optional
 from pydantic import BaseModel
 
-from opds2.models import Metadata, Publication, Link
-from opds2.helpers import build_url
+from pyopds2.models import Metadata, Publication, Link
+from pyopds2.helpers import build_url
 
 
 class DataProviderRecord(BaseModel, ABC):
     """Abstract base class for data records returned by DataProvider.
-    
+
     Consumers of this library should extend this class to define
     their own data record structure.
     """
@@ -43,20 +43,21 @@ def to_publication(self) -> Publication:
             images=self.images()
         )
 
+
 class DataProvider(ABC):
     """Abstract base class for OPDS 2.0 data providers.
-    
+
     Consumers of this library should extend this class to provide
     their own implementation for searching and retrieving publications.
-    
+
     Example:
         class MyDataProvider(DataProvider):
             def search(self, query: str, limit: int = 50, offset: int = 0) -> List[Publication]:
                 # Implement search logic
                 results = my_search_function(query, limit, offset)
                 return [self._to_publication(item) for item in results]
     """
-    
+
     TITLE: str = "Generic OPDS Service"
 
     BASE_URL: str = "http://localhost"
@@ -99,12 +100,12 @@ def params(self) -> dict:
         def page(self) -> int:
             """Calculate current page number based on offset and limit."""
             return (self.offset // self.limit) + 1 if self.limit else 1
- 
+
         @property
         def last_page(self) -> int:
             """Calculate last page number based on total and limit."""
             return (self.total + self.limit - 1) // self.limit
-    
+
         @property
         def has_more(self) -> bool:
             """Determine if there are more results beyond the current page."""
@@ -119,13 +120,13 @@ def search(
         sort: Optional[str] = None,
     ) -> 'DataProvider.SearchResponse':
         """Search for publications matching the query.
-        
+
         Args:
             query: Search query string
             limit: Maximum number of results to return (default: 50)
             offset: Offset for pagination (default: 0)
             sort: Optional sorting parameter
-            
+
         Returns:
             SearchResponse object containing search results
         """

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.0", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "opds2"
+name = "pyopds2"
 version = "0.1.0"
 description = "A Python library for generating OPDS 2.0 compliant feeds"
 readme = "README.md"
@@ -34,5 +34,5 @@ dev = [
 ]
 
 [tool.setuptools.packages.find]
-include = ["opds2*"]
+include = ["pyopds2*"]
 exclude = ["tests*"]