Development

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length = 88

.github/workflows/delete-branch.yml

@@ -13,7 +13,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Delete merged branch
-      run: gh branch delete ${{ github.head_ref }}
+      run: gh api -X DELETE repos/${{ github.repository }}/git/refs/heads/${{ github.head_ref }}
       env:
         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-

.pre-commit-config.yaml

@@ -0,0 +1,29 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+
+  - repo: https://github.com/psf/black
+    rev: 25.9.0
+    hooks:
+      - id: black
+
+  - repo: https://github.com/pycqa/isort
+    rev: 6.1.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pycqa/flake8
+    rev: 7.3.0
+    hooks:
+      - id: flake8
+
+  - repo: https://github.com/pycqa/pylint
+    rev: v3.3.9
+    hooks:
+      - id: pylint
+        args: [--rcfile=.pylintrc]

.pylintrc

@@ -337,7 +337,7 @@ indent-after-paren=4
 indent-string='    '
 
 # Maximum number of characters on a single line.
-max-line-length=100
+max-line-length=88
 
 # Maximum number of lines in a module.
 max-module-lines=1000
@@ -430,7 +430,11 @@ disable=raw-checker-failed,
         deprecated-pragma,
         use-symbolic-message-instead,
         use-implicit-booleaness-not-comparison-to-string,
-        use-implicit-booleaness-not-comparison-to-zero
+        use-implicit-booleaness-not-comparison-to-zero,
+        missing-module-docstring,
+        attribute-defined-outside-init,
+        too-few-public-methods,
+        import-error
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

pyloremgen/generator/__init__.py

@@ -0,0 +1,12 @@
+from .lorem_pdf import PDFGenerator
+from .lorem_text import LoremIpsum, LoremIpsumError
+from .pdf_utils.cover_page_template import CoverPageBuilder
+from .pdf_utils.pdf_page_settings import PagesConfigPDF
+
+__all__ = [
+    "LoremIpsum",
+    "PDFGenerator",
+    "LoremIpsumError",
+    "PagesConfigPDF",
+    "CoverPageBuilder",
+]

pyloremgen/generator/lorem_pdf.py

@@ -1,17 +1,47 @@
+from typing import Optional
+
 from reportlab.lib.styles import getSampleStyleSheet
 from reportlab.platypus import PageBreak, Paragraph
 
-from pyloremgen.generator.lorem_text import LoremIpsum
-from pyloremgen.generator.pdf_utils.cover_page_template import CoverPageBuilder
-from pyloremgen.generator.pdf_utils.pdf_page_settings import PagesConfigPDF
+from .lorem_text import LoremIpsum
+from .pdf_utils.cover_page_template import CoverPageBuilder
+from .pdf_utils.pdf_page_settings import PagesConfigPDF
 
 
 class PDFGenerator:
-    def __init__(self, pages_config=None):
+    """
+    PDFGenerator class for creating PDF documents with Lorem Ipsum content.
+
+    This class provides functionality to generate
+    PDF files filled with Lorem Ipsum text,
+    with options for customizing page settings and including cover pages.
+
+    Attributes:
+        pages_config (PagesConfigPDF): Configuration for PDF page settings.
+        lorem (LoremIpsum): Instance of LoremIpsum for generating text content.
+
+    Methods:
+        generate_pdf(filename: str, num_pages: int = 1,
+        cover_page_count: bool = True) -> None:
+            Generates a PDF document with the specified number of pages.
+    """
+
+    def __init__(self, pages_config: Optional[PagesConfigPDF] = None) -> None:
         self.pages_config = pages_config or PagesConfigPDF()
         self.lorem = LoremIpsum()
 
-    def generate_pdf(self, filename, num_pages=1, cover_page_count=True):
+    def generate_pdf(
+        self, filename: str, num_pages: int = 1, cover_page_count: bool = True
+    ) -> None:
+        """
+        Generate a PDF document with Lorem Ipsum content.
+
+        Args:
+            filename (str): The name of the output PDF file.
+            num_pages (int, optional): The number of pages to generate. Defaults to 1.
+            cover_page_count (bool, optional):
+                Whether to include a cover page. Defaults to True.
+        """
         self.num_pages = num_pages
         doc = self.pages_config.create_document(filename)
         content = []