tumblrbot 1.4.0__tar.gz → 1.4.2__tar.gz

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tumblrbot
-Version: 1.4.0
+Version: 1.4.2
 Summary: An updated bot that posts to Tumblr, based on your very own blog!
 Requires-Python: >= 3.13
 Description-Content-Type: text/markdown
@@ -11,6 +11,7 @@ Requires-Dist: niquests[speedups, http3]
 Requires-Dist: openai
 Requires-Dist: pydantic
 Requires-Dist: pydantic-settings
+Requires-Dist: requests
 Requires-Dist: requests-cache
 Requires-Dist: requests-oauthlib
 Requires-Dist: rich
@@ -73,6 +74,8 @@ Features:
 
 **To-Do:**
 - Add code documentation.
+- Fix inaccurate post counts when downloading posts.
+- Fix file not found error when starting fine-tuning.
 
 
 **Please submit an issue or contact us for features you want added/reimplemented.**
@@ -84,7 +87,8 @@ Features:
    - Linux (pacman): `pacman install python-pip`
 1. Install the [pip] package: `pip install tumblrbot`
    - Alternatively, you can install from this repository: `pip install git+https://github.com/MaidThatPrograms/tumblrbot.git`
-   - On Linux, you will have to make a virtual environment.
+   - On Linux, you will have to make a virtual environment or use the flag to install packages system-wide.
+   - See [keyring] for additional requirements if you are not on Windows.
 
 ## Usage
 Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options. Every command-line option corresponds to a value from the [config](#configuration).

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/README.md

@@ -53,6 +53,8 @@ Features:
 
 **To-Do:**
 - Add code documentation.
+- Fix inaccurate post counts when downloading posts.
+- Fix file not found error when starting fine-tuning.
 
 
 **Please submit an issue or contact us for features you want added/reimplemented.**
@@ -64,7 +66,8 @@ Features:
    - Linux (pacman): `pacman install python-pip`
 1. Install the [pip] package: `pip install tumblrbot`
    - Alternatively, you can install from this repository: `pip install git+https://github.com/MaidThatPrograms/tumblrbot.git`
-   - On Linux, you will have to make a virtual environment.
+   - On Linux, you will have to make a virtual environment or use the flag to install packages system-wide.
+   - See [keyring] for additional requirements if you are not on Windows.
 
 ## Usage
 Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options. Every command-line option corresponds to a value from the [config](#configuration).

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tumblrbot"
-version = "1.4.0"
+version = "1.4.2"
 description = "An updated bot that posts to Tumblr, based on your very own blog!"
 readme = "README.md"
 requires-python = ">= 3.13"
@@ -12,6 +12,7 @@ dependencies = [
   "openai",
   "pydantic",
   "pydantic-settings",
+  "requests",
   "requests-cache",
   "requests-oauthlib",
   "rich",

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/__main__.py

@@ -6,17 +6,18 @@ from tumblrbot.flow.download import PostDownloader
 from tumblrbot.flow.examples import ExamplesWriter
 from tumblrbot.flow.fine_tune import FineTuner
 from tumblrbot.flow.generate import DraftGenerator
+from tumblrbot.utils.common import FlowClass
 from tumblrbot.utils.models import Tokens
-from tumblrbot.utils.tumblr import TumblrClient
+from tumblrbot.utils.tumblr import TumblrSession
 
 
 def main() -> None:
     install()
 
-    tokens = Tokens()
+    tokens = Tokens.read_from_keyring()
     with (
         OpenAI(api_key=tokens.openai_api_key.get_secret_value(), http_client=DefaultHttpxClient(http2=True)) as openai,
-        TumblrClient(tokens=tokens) as tumblr,
+        TumblrSession(tokens=tokens) as tumblr,
     ):
         post_downloader = PostDownloader(openai, tumblr)
         if Confirm.ask("Download latest posts?", default=False):
@@ -30,7 +31,9 @@ def main() -> None:
 
         fine_tuner = FineTuner(openai, tumblr, estimated_tokens)
         fine_tuner.print_estimates()
-        if Confirm.ask("Upload data to OpenAI for fine-tuning? [bold]You must do this to set the model to generate drafts from. Alternatively, manually enter a model into the config.", default=False):
+
+        message = "Resume monitoring the previous fine-tuning process?" if FlowClass.config.job_id else "Upload data to OpenAI for fine-tuning?"
+        if Confirm.ask(f"{message} [bold]You must do this to set the model to generate drafts from. Alternatively, manually enter a model into the config", default=False):
             fine_tuner.fine_tune()
 
         if Confirm.ask("Generate drafts?", default=False):

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/flow/examples.py

@@ -59,7 +59,7 @@ class ExamplesWriter(FlowClass):
     def get_filtered_posts(self) -> Generator[Post]:
         posts = list(self.get_valid_posts())
 
-        if Confirm.ask("Remove posts flagged by the OpenAI moderation? This can sometimes resolve errors with fine-tuning validation, but is slow.", default=False):
+        if Confirm.ask("[gray62]Remove posts flagged by the OpenAI moderation? This can sometimes resolve errors with fine-tuning validation, but is slow.", default=False):
             removed = 0
             chunk_size = self.get_moderation_chunk_limit()
             with PreviewLive() as live:

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/flow/fine_tune.py

@@ -1,10 +1,12 @@
 from dataclasses import dataclass
 from datetime import datetime
 from textwrap import dedent
-from time import sleep
+from time import sleep, time
 
 import rich
 from openai.types.fine_tuning import FineTuningJob
+from rich import progress
+from rich.prompt import Confirm
 
 from tumblrbot.utils.common import FlowClass, PreviewLive
 
@@ -18,26 +20,27 @@ class FineTuner(FlowClass):
         rich.print(dedent(text).lstrip())
 
     def fine_tune(self) -> None:
-        with PreviewLive() as live:
-            job = self.create_job(live)
+        job = self.create_job()
 
-            self.dedent_print(f"""
-                [bold]Fine-tuning is starting...[/]
-                View it online at: https://platform.openai.com/finetune/{job.id}
-                    Created at: {datetime.fromtimestamp(job.created_at)}
-                    Base Model: {job.model}
+        self.dedent_print(f"""
+            [bold]Fine-tuning is starting...[/]
+            View it online at: https://platform.openai.com/finetune/{job.id}
+                Created at: {datetime.fromtimestamp(job.created_at)}
+                Base Model: {job.model}
 
-                [italic dim]Closing this terminal will not stop the fine-tuning. This will take a while...
-            """)  # noqa: DTZ006
+            [italic dim]Closing this terminal will not stop the fine-tuning. This will take a while...\
+        """)  # noqa: DTZ006
 
+        with PreviewLive() as live:
             task_id = live.progress.add_task("", total=None)
 
-            while job.status not in {"succeeded", "failed", "cancelled"}:
+            while job.status in {"validating_files", "queued", "running"}:
                 job = self.poll_job_status()
 
                 live.progress.update(
                     task_id,
-                    total=job.estimated_finish,
+                    total=job.estimated_finish - job.created_at if job.estimated_finish else None,
+                    completed=time() - job.created_at,
                     description=f"Fine-tuning: [italic]{job.status.replace('_', ' ').title()}[/]...",
                 )
 
@@ -45,15 +48,16 @@ class FineTuner(FlowClass):
 
         self.process_completed_job(job)
 
-    def create_job(self, live: PreviewLive) -> FineTuningJob:
+    def create_job(self) -> FineTuningJob:
         if self.config.job_id:
             return self.poll_job_status()
 
-        with live.progress.open(self.config.examples_file, "rb", description=f"Uploading {self.config.examples_file}...") as fp:
+        with progress.open(self.config.examples_file, "rb", description=f"Uploading [purple]{self.config.examples_file}[/]...") as fp:
             file = self.openai.files.create(
                 file=fp,
                 purpose="fine-tune",
             )
+        rich.print()
 
         job = self.openai.fine_tuning.jobs.create(
             model=self.config.base_model,
@@ -86,8 +90,13 @@ class FineTuner(FlowClass):
 
         self.config.job_id = ""
 
-        if job.status == "failed" and job.error is not None:
-            raise RuntimeError(job.error.message)
+        if job.status != "succeeded":
+            if Confirm.ask("[gray62]Delete uploaded examples file?", default=False):
+                self.openai.files.delete(job.training_file)
+                rich.print()
+
+            if job.status == "failed" and job.error is not None:
+                raise RuntimeError(job.error.message)
 
         if job.fine_tuned_model:
             self.config.fine_tuned_model = job.fine_tuned_model or ""

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/utils/common.py

@@ -10,7 +10,7 @@ from rich.progress import MofNCompleteColumn, Progress, SpinnerColumn, TimeElaps
 from rich.table import Table
 
 from tumblrbot.utils.config import Config
-from tumblrbot.utils.tumblr import TumblrClient
+from tumblrbot.utils.tumblr import TumblrSession
 
 
 @dataclass
@@ -18,7 +18,7 @@ class FlowClass:
     config: ClassVar = Config()  # pyright: ignore[reportCallIssue]
 
     openai: OpenAI
-    tumblr: TumblrClient
+    tumblr: TumblrSession
 
 
 class PreviewLive(Live):

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/utils/models.py

@@ -1,5 +1,5 @@
 from collections.abc import Generator
-from typing import Annotated, Any, ClassVar, Literal, override
+from typing import Annotated, Any, ClassVar, Literal, Self, override
 
 import rich
 from keyring import get_password, set_password
@@ -10,6 +10,14 @@ from requests_oauthlib import OAuth1Session
 from rich.panel import Panel
 from rich.prompt import Confirm, Prompt
 
+type SerializableSecretStr = Annotated[
+    SecretStr,
+    PlainSerializer(
+        SecretStr.get_secret_value,
+        when_used="json-unless-none",
+    ),
+]
+
 
 class FullyValidatedModel(BaseModel):
     model_config = ConfigDict(
@@ -22,13 +30,17 @@ class FullyValidatedModel(BaseModel):
 
 
 class Tokens(FullyValidatedModel):
+    class Tumblr(FullyValidatedModel):
+        client_key: SerializableSecretStr = SecretStr("")
+        client_secret: SerializableSecretStr = SecretStr("")
+        resource_owner_key: SerializableSecretStr = SecretStr("")
+        resource_owner_secret: SerializableSecretStr = SecretStr("")
+
     service_name: ClassVar = "tumblrbot"
+    username: ClassVar = "tokens"
 
-    openai_api_key: SecretStr = SecretStr("")
-    tumblr_client_key: SecretStr = SecretStr("")
-    tumblr_client_secret: SecretStr = SecretStr("")
-    tumblr_resource_owner_key: SecretStr = SecretStr("")
-    tumblr_resource_owner_secret: SecretStr = SecretStr("")
+    openai_api_key: SerializableSecretStr = SecretStr("")
+    tumblr: Tumblr = Tumblr()
 
     @staticmethod
     def online_token_prompt(url: str, *tokens: str) -> Generator[SecretStr]:
@@ -42,46 +54,44 @@ class Tokens(FullyValidatedModel):
 
         rich.print()
 
+    @classmethod
+    def read_from_keyring(cls) -> Self:
+        if json_data := get_password(cls.service_name, cls.username):
+            return cls.model_validate_json(json_data)
+        return cls()
+
     @override
     def model_post_init(self, context: object) -> None:
         super().model_post_init(context)
 
-        for name, _ in self:
-            if value := get_password(self.service_name, name):
-                setattr(self, name, value)
-
         if not self.openai_api_key.get_secret_value() or Confirm.ask("Reset OpenAI API key?", default=False):
             (self.openai_api_key,) = self.online_token_prompt("https://platform.openai.com/api-keys", "API key")
 
-        if not all(self.get_tumblr_tokens()) or Confirm.ask("Reset Tumblr API tokens?", default=False):
-            self.tumblr_client_key, self.tumblr_client_secret = self.online_token_prompt("https://tumblr.com/oauth/apps", "consumer key", "consumer secret")
-
-            oauth_session = OAuth1Session(*self.get_tumblr_tokens()[:2])
-            fetch_response = oauth_session.fetch_request_token("http://tumblr.com/oauth/request_token")
-            full_authorize_url = oauth_session.authorization_url("http://tumblr.com/oauth/authorize")
-            (redirect_response,) = self.online_token_prompt(full_authorize_url, "full redirect URL")
-            oauth_response = oauth_session.parse_authorization_response(redirect_response.get_secret_value())
-            oauth_session = OAuth1Session(
-                *self.get_tumblr_tokens()[:2],
+        if not all(self.tumblr.model_dump(mode="json").values()) or Confirm.ask("Reset Tumblr API tokens?", default=False):
+            self.tumblr.client_key, self.tumblr.client_secret = self.online_token_prompt("https://tumblr.com/oauth/apps", "consumer key", "consumer secret")
+
+            with OAuth1Session(
+                self.tumblr.client_key.get_secret_value(),
+                self.tumblr.client_secret.get_secret_value(),
+            ) as oauth_session:
+                fetch_response = oauth_session.fetch_request_token("http://tumblr.com/oauth/request_token")
+                full_authorize_url = oauth_session.authorization_url("http://tumblr.com/oauth/authorize")
+                (redirect_response,) = self.online_token_prompt(full_authorize_url, "full redirect URL")
+                oauth_response = oauth_session.parse_authorization_response(redirect_response.get_secret_value())
+
+            with OAuth1Session(
+                self.tumblr.client_key.get_secret_value(),
+                self.tumblr.client_secret.get_secret_value(),
                 fetch_response["oauth_token"],
                 fetch_response["oauth_token_secret"],
                 verifier=oauth_response["oauth_verifier"],
-            )
-            oauth_tokens = oauth_session.fetch_access_token("http://tumblr.com/oauth/access_token")
-            self.tumblr_resource_owner_key = oauth_tokens["oauth_token"]
-            self.tumblr_resource_owner_secret = oauth_tokens["oauth_token_secret"]
-
-        for name, value in self:
-            if isinstance(value, SecretStr):
-                set_password(self.service_name, name, value.get_secret_value())
-
-    def get_tumblr_tokens(self) -> tuple[str, str, str, str]:
-        return (
-            self.tumblr_client_key.get_secret_value(),
-            self.tumblr_client_secret.get_secret_value(),
-            self.tumblr_resource_owner_key.get_secret_value(),
-            self.tumblr_resource_owner_secret.get_secret_value(),
-        )
+            ) as oauth_session:
+                oauth_tokens = oauth_session.fetch_access_token("http://tumblr.com/oauth/access_token")
+
+            self.tumblr.resource_owner_key = oauth_tokens["oauth_token"]
+            self.tumblr.resource_owner_secret = oauth_tokens["oauth_token_secret"]
+
+        set_password(self.service_name, self.username, self.model_dump_json())
 
 
 class Post(FullyValidatedModel):

{tumblrbot-1.4.0 → tumblrbot-1.4.2}/src/tumblrbot/utils/tumblr.py

@@ -1,7 +1,8 @@
 from dataclasses import dataclass
 from typing import Self
 
-from niquests import HTTPError, PreparedRequest, Response, Session
+from niquests import HTTPError, Session
+from requests import Response
 from requests_cache import CacheMixin
 from requests_oauthlib import OAuth1
 
@@ -9,36 +10,35 @@ from tumblrbot.utils.models import Post, Tokens
 
 
 @dataclass
-class TumblrClient(Session, CacheMixin):  # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
+class TumblrSession(CacheMixin, Session):  # pyright: ignore[reportIncompatibleMethodOverride, reportIncompatibleVariableOverride]
     tokens: Tokens
 
     def __post_init__(self) -> None:
-        super().__init__(happy_eyeballs=True)
         CacheMixin.__init__(self, use_cache_dir=True)
+        Session.__init__(self, happy_eyeballs=True)
 
-        self.auth = OAuth1(*self.tokens.get_tumblr_tokens())
+        self.auth = OAuth1(**self.tokens.tumblr.model_dump(mode="json"))
         self.hooks["response"].append(self.response_hook)
 
     def __enter__(self) -> Self:
         super().__enter__()
         return self
 
-    def response_hook(self, response: PreparedRequest | Response) -> None:
-        if isinstance(response, Response):
-            try:
-                response.raise_for_status()
-            except HTTPError as error:
-                if response.text:
-                    error.add_note(response.text)
-                raise
+    def response_hook(self, response: Response, **_: object) -> None:
+        try:
+            response.raise_for_status()
+        except HTTPError as error:
+            if response.text:
+                error.add_note(response.text)
+            raise
 
     def retrieve_published_posts(self, blog_identifier: str, after: int) -> Response:
         return self.get(
             f"https://api.tumblr.com/v2/blog/{blog_identifier}/posts",
             params={
-                "after": str(after),
+                "after": after,
                 "sort": "asc",
-                "npf": str(True),
+                "npf": True,
             },
         )