kobo-highlights 1.0.2__tar.gz → 1.0.4__tar.gz

{kobo_highlights-1.0.2 → kobo_highlights-1.0.4}/PKG-INFO

@@ -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.2 → kobo_highlights-1.0.4}/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-1.0.2 → kobo_highlights-1.0.4}/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-1.0.2 → kobo_highlights-1.0.4}/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 → kobo_highlights-1.0.4}/pyproject.toml

@@ -1,12 +1,12 @@
-[tool.poetry]
+[project]
 name = "kobo-highlights"
-version = "1.0.2"
+version = "1.0.4"
 description = """\
     Kobo Highlights is a CLI application to manage the bookmarks of your Kobo ereader. \
     It can import them into a human-friendly markdown database.\
     """
 license = "GPL-3.0-only"
-authors = ["Pedro Videgain Barranco"]
+authors = [{ name = "Pedro Videgain Barranco", email = "pedro@vide.bar" }]
 readme = "README.md"
 homepage = "https://github.com/videbar/kobo-highlights"
 classifiers = [
@@ -14,20 +14,18 @@ classifiers = [
     "Operating System :: POSIX :: Linux",
     "Topic :: Multimedia",
 ]
+scripts = { kh = "kobo_highlights.main:app" }
+requires-python = "~=3.10"
+dependencies = [
+    "toml~=0.10.2",
+    "pydantic~=2.0",
+    "rich~=12.4.0",
+    "typer[all] (~=0.4.1)",
+]
 
-[tool.poetry.scripts]
-kh = "kobo_highlights.main:app"
-
-[tool.poetry.dependencies]
-python = "^3.10"
-typer = {extras = ["all"], version = "^0.4.1"}
-toml = "^0.10.2"
-pydantic = "^1.9.0"
-rich = "^12.2.0"
-
-[tool.poetry.dev-dependencies]
-pytest = "^7.1"
-black = "^22.3.0"
+[tool.poetry.group.dev]
+dependencies = { pytest = "~=7.1", black = "~=22.3.0" }
+optional = true
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]

kobo_highlights-1.0.2/setup.py

@@ -1,37 +0,0 @@
-# -*- coding: utf-8 -*-
-from setuptools import setup
-
-packages = \
-['kobo_highlights']
-
-package_data = \
-{'': ['*']}
-
-install_requires = \
-['pydantic>=1.9.0,<2.0.0',
- 'rich>=12.2.0,<13.0.0',
- 'toml>=0.10.2,<0.11.0',
- 'typer[all]>=0.4.1,<0.5.0']
-
-entry_points = \
-{'console_scripts': ['kh = kobo_highlights.main:app']}
-
-setup_kwargs = {
-    'name': 'kobo-highlights',
-    'version': '1.0.2',
-    'description': 'Kobo Highlights is a CLI application to manage the bookmarks of your Kobo ereader. It can import them into a human-friendly markdown database.',
-    'long_description': "**DISCLAIMER:** This is an unofficial project that I developed independently from Kobo\nand without any contact with them.\n\n# Kobo highlights \n\nKobo highlights is a simple CLI application to manage bookmarks from a Kobo erader. It\ncan import them into a markdown database where they can be easily accessed.\n\nKobo Highlights was developed in Python using [Typer](https://typer.tiangolo.com/) for\nthe CLI functionality and [Rich](https://github.com/Textualize/rich) for writing nice\ntext to the terminal.\n\nKobo highlights was develop as a personal project and it's design is based on how my\nparticular ereader handles bookmarks, so there are no guarantees that it will work on\nother models.\n\n# Requirements\n\nKobo highlights was developed and tested in [Fedora](https://getfedora.org/) and the\nautomatic tests are run in Ubuntu as macOS. I expect it to work properly on most\nLinux distributions and on macOS. It has not been testes on Windows, but you can try\nit.\n\nKobo highlights requires Python 3.10.\n\n# Installation\n\nThis project was developed using [Poetry](https://python-poetry.org/) and there are\nmultiple ways of installing it:\n\n* The recommended installation method is [downloading it from pypi](\n    https://pypi.org/project/kobo-highlights/): `pip install kobo-highlights`.\n\n* If you want to install Kobo Highlights directly from this repo note that development\ntakes place in the main branch, so make sure to install it from the commit corresponding\nto the last release.\nIn this case you cant install it with Poetry (run `poetry install` inside the repo) or\nwith pip (run `pip install .` inside the repo).\n\n# Quick guide\n\nOnce Kobo Highlights has been installed, it can be accessed running the `kh` command.\nIf you run `kh --help` you should see something like this:\n\nFrom that message, you can see that the available options from Kobo Highlights are:\n\n* `kh config` to manage your configuration.\n\n* `kh ls` to list your bookmarks. By default is prints only new bookmarks, you can use\nthe `--all` option to print all bookmarks instead.\n\n* `kh import` to import your bookmarks. It can be called with `all`, `new` (default),\na bookmark ID, a list of bookmarks IDs, a book title or a book author. Use\n`kh import --help` for more information.\n\nYou can run any of these commands with the `--help` option to find out more on how to\nuse them.\n\nThe first time you run Kobo Highlights you will be probably told that you need to create\na configuration file before doing anything else. You can just follow the instructions\nto create a valid configuration file. In the next section the program configuration is\nexplained in more detail.\n\n# Configuration\n\nKobo Highlights uses a [toml](https://github.com/toml-lang/toml) configuration file that\nis stored in the default directory \n[designated by Typer](https://typer.tiangolo.com/tutorial/app-dir/). In most Linux\nsystems this is in `~/.config/kobo_highlights`. The configuration file contains two\nfields:\n\n* `ereader_dir`: Is the absolute path to the directory where your erader is mounter.\nNotably, your ereader doesn't need to be mounted when you create the config file,\nbut you should specify the directory where you expect it to be mounted when you manage\nyour bookmarks.\n\n* `target_dir`: Is the absolute path to the directory where you want your markdown\ndatabase to be created. This database will contain one markdown file per book with\nthe highlighted text stored in block quotes.\n\nEvert time you run Kobo Highlights it will try to find a configuration file, if it\nfails, it will ask you if you want to create one interactively and save it. If you\ndon't want to create a configuration file, Kobo Highlights will stop.\n\nYou can manage your configuration file with the `kh config` command. In particular\nyou cant use `config show` to show your current configuration and `config new` to\ncreate and save a new configuration.\n\n# The markdown database\n\nThe main goal of Kobo highlights is to read the bookmarks from the ereader and format\nthem in a way in which they are easy to work with. I choose to do this by creating\na markdown database of the bookmarks. This database is located in the directory\nspecified in the configuration and will have a markdown file per book. The names\nof these files follow the convention `<book title> - <book author(s)>.md`.\n\nThe markdown files will contain, for each bookmark in that book, a\n[markdown block quote](https://spec.commonmark.org/0.30/#block-quotes) that contains\nthe text highlighted in the ereader potentially followed by a set of paragraphs\ncontaining the possible annotations that were made about the highlighted text.\n\nNote that Kobo highlights by default only imports new bookmarks to the markdown\ndatabase. To determine if a bookmark is already in the database, Kobo highlights creates\na hidden JSON file inside the markdown directory. Inside this hidden file Kobo\nHighlights stores the IDs of the bookmarks that have already been imported. This means\nthat even if you modify the markdown files (or even delete the completely), Kobo\nHighlights will  remember that bookmarks that you had imported and they will not be\nconsidered new.",
-    'author': 'Pedro Videgain Barranco',
-    'author_email': 'None',
-    'maintainer': 'None',
-    'maintainer_email': 'None',
-    'url': 'https://github.com/videbar/kobo-highlights',
-    'packages': packages,
-    'package_data': package_data,
-    'install_requires': install_requires,
-    'entry_points': entry_points,
-    'python_requires': '>=3.10,<4.0',
-}
-
-
-setup(**setup_kwargs)