kobo-highlights 1.0.2__py3-none-any.whl → 1.0.4__py3-none-any.whl

kobo_highlights/config.py

@@ -15,7 +15,7 @@ but a valid `Config` object can't be created.
 from __future__ import annotations
 from pathlib import Path
 
-from pydantic import BaseModel, Extra, ValidationError
+from pydantic import BaseModel, ValidationError
 from rich.prompt import Prompt
 from rich.table import Table
 import toml
@@ -24,7 +24,7 @@ from kobo_highlights.console import console
 
 
 # Definitions
-class Config(BaseModel, extra=Extra.forbid):
+class Config(BaseModel, extra="forbid"):
     """
     Config: Class that holds the configuration of the program. It is based on pydantic
     to ensure a correct structure and facilitate parsing. It used as a singleton in the
@@ -74,7 +74,7 @@ class Config(BaseModel, extra=Extra.forbid):
             Config: `Config` object representing the config file.
         """
         try:
-            return cls.parse_obj(toml.load(config_path))
+            return cls.model_validate(toml.load(config_path))
 
         except FileNotFoundError:
             raise ConfigError(f"No config file was found in: {config_path}")
@@ -145,10 +145,11 @@ class Config(BaseModel, extra=Extra.forbid):
         """
         # Convert the path attributes to strings:
         toml_representation: dict[str, str] = {
-            field: str(path) for field, path in self.dict().items()
+            field: str(path) for field, path in self.model_dump().items()
         }
 
-        config_filepath.write_text(toml.dumps(toml_representation))
+        config_filepath.parent.mkdir(parents=True, exist_ok=True)
+        config_filepath.write_text(toml.dumps(toml_representation), encoding="utf-8")
         return self
 
     def __rich__(self) -> Table:

kobo_highlights/functions.py

@@ -49,7 +49,6 @@ def setup_missing_config(config_path: Path) -> Config:
 
     error_console.print("[bold]No valid configuration file was found")
     if Confirm.ask("would you like to create one?"):
-
         try:
             config = Config.create_interactively().save_file(config_path)
             console.print(
@@ -122,7 +121,6 @@ def query_bookmarks_from_ereader(
     all_bookmarks: list[Bookmark] = []
 
     for bookmark_data in cursor_bookmark.execute(BM_QUERY):
-
         current_bookmark: dict = {
             "id": bookmark_data[0],
             "text": bookmark_data[1].strip(),
@@ -146,13 +144,15 @@ def query_bookmarks_from_ereader(
 
         # Query string used on the "content" table.
         CONTENT_QUERY: str = (
-            f"SELECT Title, Attribution FROM content WHERE ContentID = '{volume_id}'"
+            "SELECT Title, Attribution FROM content WHERE ContentID = ?"
             " AND ContentType = '6' LIMIT 1;"
         )
 
         # The same book can appear multiple times on the "content" table, but in order
         # to retrieve the data there's no need to query more than one result.
-        content_query_result: tuple = cursor_content.execute(CONTENT_QUERY).fetchone()
+        content_query_result: tuple = cursor_content.execute(
+            CONTENT_QUERY, (volume_id,)
+        ).fetchone()
 
         current_bookmark["title"] = content_query_result[0]
 
@@ -188,9 +188,8 @@ def query_bookmark_ids_from_json(json_filepath: Path) -> list[Bookmark_id]:
         list[Bookmark_id]: List of bookamrk IDs.
     """
     try:
-
         json_content: dict[str, list[Bookmark_id]] = json.loads(
-            json_filepath.read_text()
+            json_filepath.read_text(encoding="utf-8")
         )
 
         # The JSON file should correspond to a dictionary with the key
@@ -202,9 +201,8 @@ def query_bookmark_ids_from_json(json_filepath: Path) -> list[Bookmark_id]:
 
     # If no JSON file exists, create one.
     except FileNotFoundError:
-
         json_content: dict[str, list[Bookmark_id]] = {"imported_bookmark_ids": []}
-        json_filepath.write_text(json.dumps(json_content))
+        json_filepath.write_text(json.dumps(json_content), encoding="utf-8")
 
     # If there is a JSON file but the structure is wrong, the user will be asked if
     # they want to create a new one.
@@ -221,7 +219,7 @@ def query_bookmark_ids_from_json(json_filepath: Path) -> list[Bookmark_id]:
             console=error_console,
         ):
             json_content: dict[str, list[Bookmark_id]] = {"imported_bookmark_ids": []}
-            json_filepath.write_text(json.dumps(json_content))
+            json_filepath.write_text(json.dumps(json_content), encoding="utf-8")
 
         else:
             raise typer.Abort()
@@ -242,7 +240,9 @@ def write_bookmark_id_to_json(json_filepath: Path, id: Bookmark_id):
     if id not in stored_ids:
         stored_ids.append(id)
 
-    json_filepath.write_text(json.dumps({"imported_bookmark_ids": stored_ids}))
+    json_filepath.write_text(
+        json.dumps({"imported_bookmark_ids": stored_ids}), encoding="utf-8"
+    )
 
 
 def add_bookmark_to_md(bookmark: Bookmark, md_dir: Path):
@@ -283,8 +283,8 @@ def add_bookmark_to_md(bookmark: Bookmark, md_dir: Path):
         text_existing_file: str = f"\n\n***\n\n{md_blockquote}"
 
     if md_filepath.is_file():
-        with md_filepath.open("a") as md_file:
+        with md_filepath.open("a", encoding="utf-8") as md_file:
             md_file.write(text_existing_file)
 
     else:
-        md_filepath.write_text(text_new_file)
+        md_filepath.write_text(text_new_file, encoding="utf-8")

kobo_highlights/main.py

@@ -1,6 +1,7 @@
 """This module contains the typer app (the CLI app) and the definitions for all the
 programs commands.
 """
+
 # Imports:
 from pathlib import Path
 
@@ -34,6 +35,7 @@ app = typer.Typer(
 config_app = typer.Typer(help="Manage the program configuration.")
 app.add_typer(config_app, name="config")
 
+
 # Initial setup:
 @app.callback()
 def setup():
@@ -142,8 +144,8 @@ def import_highlights(
                 JSON_PATH
             )
 
-            # Filter the bookmark to print to include only those that are in the ereader
-            # but not on the markdown files.
+            # Filter the bookmarks to import only those that are in the ereader but
+            # not on the markdown files.
             bookmarks_to_save = [
                 bm for bm in ereader_bookmarks if bm["id"] not in md_bookmarks_ids
             ]
@@ -157,13 +159,14 @@ def import_highlights(
         case "all":
             for bookmark in ereader_bookmarks:
                 add_bookmark_to_md(bookmark, config.target_dir)
+                write_bookmark_id_to_json(JSON_PATH, bookmark["id"])
 
             console.print("[cyan]All Bookmarks have been imported")
 
         case _:
 
-            # If the value is neither all nor new, the program checks in order if it is
-            # a id, or a list of ids, a book title or a book author.
+            # If the value is neither all nor new, the program checks in order to see if
+            # it is an id, a list of ids, a book title, or a book author.
 
             all_ids, all_titles, all_authors = [], [], []
 
@@ -172,13 +175,14 @@ def import_highlights(
                 all_titles.append(bookmark["title"])
                 all_authors.append(bookmark["author"])
 
-            # Check first if it is a list of ids:
+            # Check first if the input is composed of ids:
             selected_ids: list = bookmark_selection.split()
             if all(id in all_ids for id in selected_ids):
 
                 for bookmark in ereader_bookmarks:
                     if bookmark["id"] in selected_ids:
                         add_bookmark_to_md(bookmark, config.target_dir)
+                        write_bookmark_id_to_json(JSON_PATH, bookmark["id"])
 
                 # To print to the console:
                 id_list_to_print: str = "\n".join(selected_ids)
@@ -192,6 +196,7 @@ def import_highlights(
                 for bookmark in ereader_bookmarks:
                     if bookmark["title"] == bookmark_selection:
                         add_bookmark_to_md(bookmark, config.target_dir)
+                        write_bookmark_id_to_json(JSON_PATH, bookmark["id"])
                 console.print(
                     f"[green]All bookmarks from the book {bookmark_selection} have"
                     " been imported"
@@ -202,6 +207,7 @@ def import_highlights(
                 for bookmark in ereader_bookmarks:
                     if bookmark["author"] == bookmark_selection:
                         add_bookmark_to_md(bookmark, config.target_dir)
+                        write_bookmark_id_to_json(JSON_PATH, bookmark["id"])
                 console.print(
                     f"[green]All bookmarks from the Author {bookmark_selection} have"
                     " been imported"

{kobo_highlights-1.0.2.dist-info → kobo_highlights-1.0.4.dist-info}/METADATA

@@ -1,20 +1,16 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: kobo-highlights
-Version: 1.0.2
+Version: 1.0.4
 Summary: Kobo Highlights is a CLI application to manage the bookmarks of your Kobo ereader. It can import them into a human-friendly markdown database.
-Home-page: https://github.com/videbar/kobo-highlights
 License: GPL-3.0-only
 Author: Pedro Videgain Barranco
-Requires-Python: >=3.10,<4.0
+Author-email: pedro@vide.bar
+Requires-Python: ~=3.10
 Classifier: Environment :: Console
-Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
 Classifier: Operating System :: POSIX :: Linux
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Topic :: Multimedia
-Requires-Dist: pydantic (>=1.9.0,<2.0.0)
-Requires-Dist: rich (>=12.2.0,<13.0.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: rich (>=12.4.0,<12.5.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: typer[all] (>=0.4.1,<0.5.0)
 Description-Content-Type: text/markdown

kobo_highlights-1.0.4.dist-info/RECORD

@@ -0,0 +1,10 @@
+kobo_highlights/__init__.py,sha256=IMjkMO3twhQzluVTo8Z6rE7Eg-9U79_LGKMcsWLKBkY,22
+kobo_highlights/config.py,sha256=uuzXRD-eK4Q_rc0mfHkmeGJqmO-lPx4FKxum2IqOWiM,6445
+kobo_highlights/console.py,sha256=wwsT6W7sqANfMW91YAzA0EN2BJhNDxunG8ooZJ06Zys,228
+kobo_highlights/functions.py,sha256=0gazUqPeMK3crUgr10dbkLblbNG77ug1LYa6ik0FnTI,11223
+kobo_highlights/main.py,sha256=ngrEUjS6maiQVn3VaIiSrXiUEkUurAAK1OAfFra-zqo,8078
+kobo_highlights-1.0.4.dist-info/LICENSE,sha256=5X8cMguM-HmKfS_4Om-eBqM6A1hfbgZf6pfx2G24QFI,35150
+kobo_highlights-1.0.4.dist-info/METADATA,sha256=WMEiuK3aLF2X9IyfBKqwbi_05n8pwrNMHuYZ5nearPs,5765
+kobo_highlights-1.0.4.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+kobo_highlights-1.0.4.dist-info/entry_points.txt,sha256=IDy9Bk-Jd6f-mcG6Dm7DJ9Ad-scSwGa2zcUqQbUDodY,47
+kobo_highlights-1.0.4.dist-info/RECORD,,

{kobo_highlights-1.0.2.dist-info → kobo_highlights-1.0.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.3.2
+Generator: poetry-core 2.1.3
 Root-Is-Purelib: true
 Tag: py3-none-any

kobo_highlights-1.0.2.dist-info/RECORD

@@ -1,10 +0,0 @@
-kobo_highlights/__init__.py,sha256=IMjkMO3twhQzluVTo8Z6rE7Eg-9U79_LGKMcsWLKBkY,22
-kobo_highlights/config.py,sha256=yOPeYcSovJEhFPSTT1wHVElwgVc8M2gKFdW5zC1f-kM,6361
-kobo_highlights/console.py,sha256=wwsT6W7sqANfMW91YAzA0EN2BJhNDxunG8ooZJ06Zys,228
-kobo_highlights/functions.py,sha256=8DY2eTEMKWQ84xyMjze0RrxUo7EYF2oV-OEDVT-OrL0,11084
-kobo_highlights/main.py,sha256=RLDz0XWI00lukcffHYgLvlLhpnklLsSP_VXBtQjYmUA,7770
-kobo_highlights-1.0.2.dist-info/entry_points.txt,sha256=IDy9Bk-Jd6f-mcG6Dm7DJ9Ad-scSwGa2zcUqQbUDodY,47
-kobo_highlights-1.0.2.dist-info/LICENSE,sha256=5X8cMguM-HmKfS_4Om-eBqM6A1hfbgZf6pfx2G24QFI,35150
-kobo_highlights-1.0.2.dist-info/WHEEL,sha256=vxFmldFsRN_Hx10GDvsdv1wroKq8r5Lzvjp6GZ4OO8c,88
-kobo_highlights-1.0.2.dist-info/METADATA,sha256=efb_Sn34blzn5X6AK2AWlfncv9Es0m_UAJgx4Qa7j1o,6026
-kobo_highlights-1.0.2.dist-info/RECORD,,