From a20ae3fad04a9b95f82be13c51b54c567565bfa0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Richard=20Kub=C3=AD=C4=8Dek?= <rici.kubicek@gmail.com>
Date: Fri, 28 Feb 2025 19:17:41 +0100
Subject: [PATCH] examples: add examples to the docs

---
 docs/source/examples.rst | 19 +++++++++++++++++++
 docs/source/index.rst    |  1 +
 examples/add_invoice.py  |  9 ++++++++-
 examples/tools.py        |  6 ++++--
 4 files changed, 32 insertions(+), 3 deletions(-)
 create mode 100644 docs/source/examples.rst

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
new file mode 100644
index 0000000..d0c5e94
--- /dev/null
+++ b/docs/source/examples.rst
@@ -0,0 +1,19 @@
+Examples of SuperFaktura API client usage
+====================
+
+
+Add Invoice
+---------------------------------
+
+.. automodule:: examples.add_invoice
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Get country list
+------------------------------------
+
+.. automodule:: examples.get_country_list
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f27d38e..4f2a10f 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -6,3 +6,4 @@ Welcome to SuperFaktura Client's documentation
 
    superfaktura
    installation
+   examples
diff --git a/examples/add_invoice.py b/examples/add_invoice.py
index 130f618..9184a9b 100644
--- a/examples/add_invoice.py
+++ b/examples/add_invoice.py
@@ -36,7 +36,10 @@ from superfaktura.invoice import (
 from superfaktura.utils.data_types import Date
 
 
-if __name__ == "__main__":
+def main():
+    """
+    Main function to add Invoice and save it as a pdf using the SuperFaktura API.
+    """
     invoice = Invoice()
     bank = BankAccount()
     resp = invoice.add(
@@ -70,3 +73,7 @@ if __name__ == "__main__":
     _pdf = invoice.get_pdf(invoice=resp, language=Language.English)
 
     save_file_as_pdf(_pdf, "invoice.pdf")
+
+
+if __name__ == "__main__":
+    main()
diff --git a/examples/tools.py b/examples/tools.py
index 3a56cc9..840552e 100644
--- a/examples/tools.py
+++ b/examples/tools.py
@@ -2,6 +2,8 @@
 This module contains tools for working with these examples.
 """
 
+from pathlib import Path
+
 
 def save_file_as_pdf(input_data: bytes, output_path: str = "output.pdf") -> None:
     """
@@ -10,5 +12,5 @@ def save_file_as_pdf(input_data: bytes, output_path: str = "output.pdf") -> None
     :param output_path:
     :return:
     """
-    with open(output_path, "wb") as f:
-        f.write(input_data)
+    p = Path(output_path)
+    p.write_bytes(input_data)