feat: clean and doc

Author: Strvm

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Roméo PHILLIPS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pyproject.toml

@@ -9,14 +9,10 @@ description = "Export and download Notion pages asynchronously."
 authors = ["Romeo Phillips"]
 
 [tool.poetry.dependencies]
-python = "^3.7"  # or whichever version you're targeting
-certifi = "2023.7.22"
-charset-normalizer = "3.2.0"
-idna = "3.4"
+python = "^3.7"
 requests = "2.31.0"
 tqdm = "4.66.1"
 urllib3 = "2.0.4"
-wheel = "0.41.2"
 
 
 [build]

src/python_notion_exporter/main.py

@@ -12,13 +12,13 @@
 from tqdm import tqdm
 
 
-class ExportType():
+class ExportType:
     MARKDOWN = "markdown"
     HTML = "html"
     PDF = "pdf"
 
 
-class ViewExportType():
+class ViewExportType:
     CURRENT_VIEW = "currentView"
     ALL = "all"
 
@@ -37,6 +37,22 @@ def __init__(
         recursive=True,
         workers=multiprocessing.cpu_count(),
     ):
+        """
+        Initializes the NotionExporter class.
+
+        Args:
+            token_v2 (str): The user's Notion V2 token.
+            file_token (str): The user's file token for Notion.
+            pages (dict): Dictionary of pages to be exported.
+            export_directory (str, optional): Directory where exports will be saved. Defaults to the current directory.
+            flatten_export_file_tree (bool, optional): If True, flattens the export file tree. Defaults to True.
+            export_type (ExportType, optional): Type of export (e.g., MARKDOWN, HTML, PDF). Defaults to MARKDOWN.
+            current_view_export_type (ViewExportType, optional): Type of view export (e.g., CURRENT_VIEW, ALL). Defaults to CURRENT_VIEW.
+            include_files (bool, optional): If True, includes files in the export. Defaults to False.
+            recursive (bool, optional): If True, exports will be recursive. Defaults to True.
+            workers (int, optional): Number of worker threads for exporting. Defaults to the number of CPUs available.
+        """
+
         self.export_name = f"export-{datetime.now().strftime('%Y-%m-%d-%H-%M-%S')}"
         self.token_v2 = token_v2
         self.file_token = file_token
@@ -59,11 +75,30 @@ def __init__(
         os.makedirs(f"{self.export_directory}{self.export_name}", exist_ok=True)
 
     def _to_uuid_format(self, s):
+        """
+        Converts a string to UUID format.
+
+        Args:
+            s (str): The input string.
+
+        Returns:
+            str: The string in UUID format.
+        """
         if "-" == s[8] and "-" == s[13] and "-" == s[18] and "-" == s[23]:
             return s
         return f"{s[:8]}-{s[8:12]}-{s[12:16]}-{s[16:20]}-{s[20:]}"
 
     def _get_format_options(self, export_type: ExportType, include_files=False):
+        """
+        Retrieves format options based on the export type and whether to include files.
+
+        Args:
+            export_type (ExportType): Type of export (e.g., MARKDOWN, HTML, PDF).
+            include_files (bool, optional): If True, includes files in the export. Defaults to False.
+
+        Returns:
+            dict: A dictionary containing format options.
+        """
         format_options = {}
         if export_type == ExportType.PDF:
             format_options["pdfFormat"] = "Letter"
@@ -74,6 +109,15 @@ def _get_format_options(self, export_type: ExportType, include_files=False):
         return format_options
 
     def _export(self, id):
+        """
+        Initiates the export of a Notion page.
+
+        Args:
+            id (str): The ID of the Notion page.
+
+        Returns:
+            str: The task ID of the initiated export.
+        """
         url = "https://www.notion.so/api/v3/enqueueTask"
         id = self._to_uuid_format(s=id)
         export_options = {
@@ -112,6 +156,15 @@ def _export(self, id):
         return response["taskId"]
 
     def _get_status(self, task_id):
+        """
+        Fetches the status of an export task.
+
+        Args:
+            task_id (str): The ID of the export task.
+
+        Returns:
+            dict: A dictionary containing details about the task status.
+        """
         url = "https://www.notion.so/api/v3/getTasks"
 
         payload = json.dumps({"taskIds": [task_id]})
@@ -122,6 +175,12 @@ def _get_status(self, task_id):
         return response[0]
 
     def _download(self, url):
+        """
+        Downloads an exported file from a given URL.
+
+        Args:
+            url (str): The URL of the exported file.
+        """
         response = requests.request("GET", url, headers=self.download_headers)
         file_name = url.split("/")[-1][100:]
         with open(
@@ -131,6 +190,15 @@ def _download(self, url):
             f.write(response.content)
 
     def _process_page(self, page_details):
+        """
+        Processes an individual Notion page for export.
+
+        Args:
+            page_details (tuple): Tuple containing the name and ID of the Notion page.
+
+        Returns:
+            dict: Details about the export status and any errors.
+        """
         name, id = page_details
         task_id = self._export(id)
 
@@ -155,10 +223,17 @@ def _process_page(self, page_details):
         }
 
     def _wait_for_export_completion(self, task_id):
-        """Helper method to wait until the export is complete or failed."""
+        """
+        Waits until a given export task completes or fails.
+
+        Args:
+            task_id (str): The ID of the export task.
+
+        Returns:
+            tuple: A tuple containing the status, state, error, and number of pages exported.
+        """
         while True:
             status = self._get_status(task_id)
-            # print(status)
 
             if not status:
                 time.sleep(1)
@@ -175,6 +250,9 @@ def _wait_for_export_completion(self, task_id):
             time.sleep(1)
 
     def _unpack(self):
+        """
+        Unpacks and saves exported content from zip archives.
+        """
         directory_path = f"{self.export_directory}{self.export_name}"
         for file in os.listdir(directory_path):
             if file.endswith(".zip"):
@@ -183,11 +261,17 @@ def _unpack(self):
                 os.remove(full_file_path)
 
     def process(self):
+        """
+        Processes and exports all provided Notion pages.
+        """
         logging.info(f"Exporting {len(self.pages)} pages...")
 
         with ThreadPoolExecutor(max_workers=self.workers) as executor:
             with tqdm(total=len(self.pages), dynamic_ncols=True) as pbar:
-                futures = {executor.submit(self._process_page, item): item for item in self.pages.items()}
+                futures = {
+                    executor.submit(self._process_page, item): item
+                    for item in self.pages.items()
+                }
                 for future in concurrent.futures.as_completed(futures):
                     result = future.result()
                     if result["state"] == "failure":