tumblrbot 1.2.0__tar.gz → 1.3.0__tar.gz

tumblrbot-1.3.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: tumblrbot
+Version: 1.3.0
+Summary: An updated bot that posts to Tumblr, based on your very own blog!
+Requires-Python: >= 3.13
+Description-Content-Type: text/markdown
+Requires-Dist: keyring
+Requires-Dist: more-itertools
+Requires-Dist: openai
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Requires-Dist: requests
+Requires-Dist: requests-oauthlib
+Requires-Dist: rich
+Requires-Dist: tiktoken
+Requires-Dist: tomlkit
+Project-URL: Source, https://github.com/MaidThatPrograms/tumblrbot
+
+[OAuth]: https://oauth.net/1
+[OpenAI]: https://pypi.org/project/openai
+[Python]: https://python.org/download
+[Tumblr]: https://tumblr.com
+
+[keyring]: https://pypi.org/project/keyring
+[Rich]: https://pypi.org/project/rich
+
+[Moderation API]: https://platform.openai.com/docs/api-reference/moderations
+[pip]: https://pypi.org
+
+[Download]: src/tumblrbot/flow/download.py
+[Examples]: src/tumblrbot/flow/examples.py
+[Fine-Tune]: src/tumblrbot/flow/fine_tune.py
+[Generate]: src/tumblrbot/flow/generate.py
+[Main]: src/tumblrbot/__main__.py
+[README.md]: README.md
+
+[config]: #configuration
+
+# tumblrbot
+[![PyPI - Version](https://img.shields.io/pypi/v/tumblrbot)](https://python.org/pypi/tumblrbot)
+
+Description of original project:
+> 4tv-tumblrbot was a collaborative project I embarked on with my close friend Dima, who goes by @smoqueen on Tumblr. The aim of this endeavor was straightforward yet silly: to develop a Tumblr bot powered by a machine-learning model. This bot would be specifically trained on the content from a particular Tumblr blog or a selected set of blogs, allowing it to mimic the style, tone, and thematic essence of the original posts.
+
+This fork is largely a rewrite of the source code with similarities in its structure and process.
+
+Features:
+- An [interactive console][Main] for all steps of generating posts for the blog:
+   1. Asks for [OpenAI] and [Tumblr] tokens.
+      - Stores API tokens using [keyring].
+      - Prevents API tokens from printing to the console.
+   1. Retrieves [Tumblr] [OAuth] tokens.
+   1. [Downloads posts][Download] from the [configured][config] [Tumblr] blogs.
+      - Skips redownloading already downloaded posts.
+      - Shows progress and previews the current post.
+   1. [Creates examples][Examples] to fine-tune the model from your posts.
+      - Filters out posts that contain more than just text data.
+      - Filters out any posts flagged by the [OpenAI] [Moderation API] (optional).
+         - Shows progress and previews the current post.
+      - Formats asks as the user message and the responses as the assistant response.
+      - Adds custom user messages and assistant responses to the dataset from the [configured][config] file.
+   1. Provides cost estimates if the currently saved examples are used to fine-tune the [configured][config] model.
+   1. [Uploads examples][Fine-Tune] to [OpenAI] and begins the fine-tuning process.
+      - Resumes monitoring the same fine-tuning process when restarted.
+      - Stores the output model automatically when fine-tuning is completed.
+   1. [Generates and uploads posts][Generate] to the [configured][config] [Tumblr] blog using the [configured][config] fine-tuned model.
+      - Creates tags by extracting keywords at the [configured][config] frequency using the [configured][config] model.
+      - Uploads posts as drafts to the [configured][config] [Tumblr] blog.
+      - Shows progress and previews the current post.
+- Colorful output, progress bars, and post previews using [rich].
+- Automatically keeps the [config] file up-to-date and recreates it if missing.
+
+**To-Do:**
+- Add documentation.
+- Finish updating [README.md].
+
+
+**Please submit an issue or contact us for features you want added/reimplemented.**
+
+## Installation
+1. Install the latest version of [Python]:
+   - Windows: `winget install python3`
+   - Linux (apt): `apt install python-pip`
+   - 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.
+
+## Usage
+Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options. Every command-line option corresponds to a value from the [config](#configuration).
+
+## Obtaining Tokens
+- The [OpenAI] API token can be created [here](https://platform.openai.com/settings/organization/api-keys).
+   1. Leave everything at the defaults and set `Project` to `Default Project`.
+   1. Press `Create secret key`.
+   1. Press `Copy` to copy the API token to your clipboard.
+- The [Tumblr] API tokens can be created [here](https://tumblr.com/oauth/apps).
+   1. Press `+ Register Application`.
+   1. Enter anything for `Application Name` and `Application Description`.
+   1. Enter any URL for `Application Website` and `Default callback URL`, like `https://example.com`.
+   1. Enter any email address for `Administrative contact email`. It probably doesn't need to be one you have access to.
+   1. Press the checkbox next to `I'm not a robot` and complete the CAPTCHA.
+   1. Press `Register`.
+   1. You now have access to your `consumer key` next to `Oauth Consumer Key`.
+   1. Press `Show secret key` to see your `Consumer Secret`.
+
+When running this program, you will be prompted to enter all of these tokens. **The fields are password-protected, so there will be no output to the console.** If something goes wrong while entering the tokens, you can always reset them by running the program again and answering `y` to the relevant prompt.
+
+After inputting the [Tumblr] tokens, you will be given a URL that you need to open in your browser. Press `Allow`, then copy and paste the URL of the page you are redirected to into the console.
+
+## Configuration
+All config options can be found in `config.toml` after running the program once. This will be kept up-to-date if there are changes to the config's format in a future update. This also means it may be worthwhile to double-check the config file after an update. Any changes to the config should be in the changelog for a given version.
+> WIP: There will be more information about the config options soon.
+

tumblrbot-1.3.0/README.md

@@ -0,0 +1,95 @@
+[OAuth]: https://oauth.net/1
+[OpenAI]: https://pypi.org/project/openai
+[Python]: https://python.org/download
+[Tumblr]: https://tumblr.com
+
+[keyring]: https://pypi.org/project/keyring
+[Rich]: https://pypi.org/project/rich
+
+[Moderation API]: https://platform.openai.com/docs/api-reference/moderations
+[pip]: https://pypi.org
+
+[Download]: src/tumblrbot/flow/download.py
+[Examples]: src/tumblrbot/flow/examples.py
+[Fine-Tune]: src/tumblrbot/flow/fine_tune.py
+[Generate]: src/tumblrbot/flow/generate.py
+[Main]: src/tumblrbot/__main__.py
+[README.md]: README.md
+
+[config]: #configuration
+
+# tumblrbot
+[![PyPI - Version](https://img.shields.io/pypi/v/tumblrbot)](https://python.org/pypi/tumblrbot)
+
+Description of original project:
+> 4tv-tumblrbot was a collaborative project I embarked on with my close friend Dima, who goes by @smoqueen on Tumblr. The aim of this endeavor was straightforward yet silly: to develop a Tumblr bot powered by a machine-learning model. This bot would be specifically trained on the content from a particular Tumblr blog or a selected set of blogs, allowing it to mimic the style, tone, and thematic essence of the original posts.
+
+This fork is largely a rewrite of the source code with similarities in its structure and process.
+
+Features:
+- An [interactive console][Main] for all steps of generating posts for the blog:
+   1. Asks for [OpenAI] and [Tumblr] tokens.
+      - Stores API tokens using [keyring].
+      - Prevents API tokens from printing to the console.
+   1. Retrieves [Tumblr] [OAuth] tokens.
+   1. [Downloads posts][Download] from the [configured][config] [Tumblr] blogs.
+      - Skips redownloading already downloaded posts.
+      - Shows progress and previews the current post.
+   1. [Creates examples][Examples] to fine-tune the model from your posts.
+      - Filters out posts that contain more than just text data.
+      - Filters out any posts flagged by the [OpenAI] [Moderation API] (optional).
+         - Shows progress and previews the current post.
+      - Formats asks as the user message and the responses as the assistant response.
+      - Adds custom user messages and assistant responses to the dataset from the [configured][config] file.
+   1. Provides cost estimates if the currently saved examples are used to fine-tune the [configured][config] model.
+   1. [Uploads examples][Fine-Tune] to [OpenAI] and begins the fine-tuning process.
+      - Resumes monitoring the same fine-tuning process when restarted.
+      - Stores the output model automatically when fine-tuning is completed.
+   1. [Generates and uploads posts][Generate] to the [configured][config] [Tumblr] blog using the [configured][config] fine-tuned model.
+      - Creates tags by extracting keywords at the [configured][config] frequency using the [configured][config] model.
+      - Uploads posts as drafts to the [configured][config] [Tumblr] blog.
+      - Shows progress and previews the current post.
+- Colorful output, progress bars, and post previews using [rich].
+- Automatically keeps the [config] file up-to-date and recreates it if missing.
+
+**To-Do:**
+- Add documentation.
+- Finish updating [README.md].
+
+
+**Please submit an issue or contact us for features you want added/reimplemented.**
+
+## Installation
+1. Install the latest version of [Python]:
+   - Windows: `winget install python3`
+   - Linux (apt): `apt install python-pip`
+   - 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.
+
+## Usage
+Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options. Every command-line option corresponds to a value from the [config](#configuration).
+
+## Obtaining Tokens
+- The [OpenAI] API token can be created [here](https://platform.openai.com/settings/organization/api-keys).
+   1. Leave everything at the defaults and set `Project` to `Default Project`.
+   1. Press `Create secret key`.
+   1. Press `Copy` to copy the API token to your clipboard.
+- The [Tumblr] API tokens can be created [here](https://tumblr.com/oauth/apps).
+   1. Press `+ Register Application`.
+   1. Enter anything for `Application Name` and `Application Description`.
+   1. Enter any URL for `Application Website` and `Default callback URL`, like `https://example.com`.
+   1. Enter any email address for `Administrative contact email`. It probably doesn't need to be one you have access to.
+   1. Press the checkbox next to `I'm not a robot` and complete the CAPTCHA.
+   1. Press `Register`.
+   1. You now have access to your `consumer key` next to `Oauth Consumer Key`.
+   1. Press `Show secret key` to see your `Consumer Secret`.
+
+When running this program, you will be prompted to enter all of these tokens. **The fields are password-protected, so there will be no output to the console.** If something goes wrong while entering the tokens, you can always reset them by running the program again and answering `y` to the relevant prompt.
+
+After inputting the [Tumblr] tokens, you will be given a URL that you need to open in your browser. Press `Allow`, then copy and paste the URL of the page you are redirected to into the console.
+
+## Configuration
+All config options can be found in `config.toml` after running the program once. This will be kept up-to-date if there are changes to the config's format in a future update. This also means it may be worthwhile to double-check the config file after an update. Any changes to the config should be in the changelog for a given version.
+> WIP: There will be more information about the config options soon.

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "tumblrbot"
-version = "1.2.0"
+version = "1.3.0"
 description = "An updated bot that posts to Tumblr, based on your very own blog!"
 readme = "README.md"
 requires-python = ">= 3.13"

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/__main__.py

@@ -6,14 +6,15 @@ 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 TumblrClient
-from tumblrbot.utils.settings import Tokens
+from tumblrbot.utils.models import Tokens
+from tumblrbot.utils.tumblr import TumblrClient
 
 
 def main() -> None:
     install()
+
     tokens = Tokens()
-    with OpenAI(api_key=tokens.openai_api_key.get_secret_value()) as openai, TumblrClient(tokens) as tumblr:
+    with OpenAI(api_key=tokens.openai_api_key.get_secret_value()) as openai, TumblrClient(tokens=tokens) as tumblr:
         post_downloader = PostDownloader(openai, tumblr)
         if Confirm.ask("Download latest posts?", default=False):
             post_downloader.download()

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/flow/download.py

@@ -2,11 +2,11 @@ from io import TextIOBase
 from json import dump
 from pathlib import Path
 
-from tumblrbot.utils.common import PreviewLive, UtilClass
+from tumblrbot.utils.common import FlowClass, PreviewLive
 from tumblrbot.utils.models import Post
 
 
-class PostDownloader(UtilClass):
+class PostDownloader(FlowClass):
     def paginate_posts(self, blog_identifier: str, completed: int, after: int, fp: TextIOBase, live: PreviewLive) -> None:
         task_id = live.progress.add_task(f"Downloading posts from '{blog_identifier}'...", total=None, completed=completed)
 

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/flow/examples.py

@@ -8,17 +8,18 @@ from typing import IO
 
 import rich
 from more_itertools import chunked
-from openai import BadRequestError
+from openai import BadRequestError, OpenAI
 from rich.console import Console
 from rich.prompt import Confirm
 from tiktoken import encoding_for_model, get_encoding
 
-from tumblrbot.utils.common import PreviewLive, UtilClass
+from tumblrbot.utils.common import FlowClass, PreviewLive
 from tumblrbot.utils.models import Example, Post
 
 
 @dataclass
-class ExamplesWriter(UtilClass):
+class ExamplesWriter(FlowClass):
+    openai: OpenAI
     data_paths: list[Path]
 
     def count_tokens(self) -> Generator[int]:
@@ -52,7 +53,7 @@ class ExamplesWriter(UtilClass):
             with data_path.open(encoding="utf_8") as fp:
                 for line in fp:
                     post = Post.model_validate_json(line)
-                    if post.get_text_content() and not (post.is_submission or post.trail):
+                    if not (post.is_submission or post.trail) and post.only_text_blocks() and post.get_response_content():
                         yield post
 
     def get_filtered_posts(self) -> Generator[Post]:
@@ -67,7 +68,7 @@ class ExamplesWriter(UtilClass):
                     ceil(len(posts) / chunk_size),
                     description="Removing flagged posts...",
                 ):
-                    response = self.openai.moderations.create(input=list(map(Post.get_text_content, chunk)))
+                    response = self.openai.moderations.create(input=["\n".join(post.get_text_content()) for post in chunk])
                     for post, moderation in zip(chunk, response.results, strict=True):
                         if moderation.flagged:
                             removed += 1
@@ -88,9 +89,11 @@ class ExamplesWriter(UtilClass):
 
         with self.config.examples_file.open("w", encoding="utf_8") as fp:
             for post in self.get_filtered_posts():
+                ask_content, response_content = post.get_text_content()
+
                 self.write_example(
-                    None,
-                    post.get_text_content(),
+                    ask_content or self.config.user_message,
+                    response_content,
                     fp,
                 )
 
@@ -103,15 +106,12 @@ class ExamplesWriter(UtilClass):
 
         rich.print(f"[bold]The examples file can be found at: '{self.config.examples_file}'\n")
 
-    def write_example(self, user_input: str | None, assistant_message: str, fp: IO[str]) -> None:
+    def write_example(self, user_message: str, assistant_message: str, fp: IO[str]) -> None:
         example = Example(
             messages=[
                 Example.Message(role="developer", content=self.config.developer_message),
+                Example.Message(role="user", content=user_message),
                 Example.Message(role="assistant", content=assistant_message),
             ],
         )
-
-        if user_input:
-            example.messages.insert(1, Example.Message(role="user", content=user_input))
-
         fp.write(f"{example.model_dump_json()}\n")

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/flow/fine_tune.py

@@ -6,11 +6,11 @@ from time import sleep
 import rich
 from openai.types.fine_tuning import FineTuningJob
 
-from tumblrbot.utils.common import PreviewLive, UtilClass
+from tumblrbot.utils.common import FlowClass, PreviewLive
 
 
 @dataclass
-class FineTuner(UtilClass):
+class FineTuner(FlowClass):
     estimated_tokens: int
 
     @staticmethod

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/flow/generate.py

@@ -2,11 +2,11 @@ from random import random
 
 import rich
 
-from tumblrbot.utils.common import PreviewLive, UtilClass
+from tumblrbot.utils.common import FlowClass, PreviewLive
 from tumblrbot.utils.models import Post
 
 
-class DraftGenerator(UtilClass):
+class DraftGenerator(FlowClass):
     def generate_tags(self, content: Post.Block) -> Post | None:
         if random() < self.config.tags_chance:  # noqa: S311
             return self.openai.responses.parse(
@@ -47,8 +47,8 @@ class DraftGenerator(UtilClass):
                     post = self.generate_post()
                     self.tumblr.create_post(self.config.upload_blog_identifier, post)
                     live.custom_update(post)
-                except BaseException as exc:
-                    exc.add_note(f"📉 An error occurred! Generated {i} draft(s) before failing. {message}")
+                except BaseException as exception:
+                    exception.add_note(f"📉 An error occurred! Generated {i} draft(s) before failing. {message}")
                     raise
 
         rich.print(f":chart_increasing: [bold green]Generated {self.config.draft_count} draft(s).[/] {message}")

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/utils/common.py

@@ -9,7 +9,7 @@ from rich.live import Live
 from rich.progress import MofNCompleteColumn, Progress, SpinnerColumn, TimeElapsedColumn
 from rich.table import Table
 
-from tumblrbot.utils.settings import Config
+from tumblrbot.utils.config import Config
 from tumblrbot.utils.tumblr import TumblrClient
 
 
@@ -41,7 +41,7 @@ class PreviewLive(Live):
 
 
 @dataclass
-class UtilClass:
+class FlowClass:
     config: ClassVar = Config()  # pyright: ignore[reportCallIssue]
 
     openai: OpenAI

tumblrbot-1.2.0/src/tumblrbot/utils/settings.py → tumblrbot-1.3.0/src/tumblrbot/utils/config.py

@@ -1,16 +1,13 @@
-import json
-from collections.abc import Generator, Sequence
+from collections.abc import Sequence
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, ClassVar, Self, override
+from typing import TYPE_CHECKING, Self, override
 
 import rich
 import tomlkit
-from keyring import get_password, set_password
 from openai.types import ChatModel
 from pydantic import Field, PositiveFloat, PositiveInt, Secret, model_validator
 from pydantic_settings import BaseSettings, PydanticBaseSettingsSource, SettingsConfigDict, TomlConfigSettingsSource
-from requests_oauthlib import OAuth2Session
-from rich.prompt import Confirm, Prompt
+from rich.prompt import Prompt
 from tomlkit import comment, document
 
 if TYPE_CHECKING:
@@ -92,70 +89,3 @@ class Config(BaseSettings):
             tomlkit.dumps(toml_table),  # pyright: ignore[reportUnknownMemberType]
             encoding="utf_8",
         )
-
-
-class Tokens(BaseSettings):
-    service_name: ClassVar = "tumblrbot"
-    model_config = SettingsConfigDict(toml_file="env.toml")
-
-    openai_api_key: Secret[str] = Secret("")
-    tumblr_client_id: Secret[str] = Secret("")
-    tumblr_client_secret: Secret[str] = Secret("")
-    tumblr_token: Secret[Any] = Secret({})
-
-    @staticmethod
-    def online_token_prompt(url: str, *tokens: str) -> Generator[Secret[str]]:
-        formatted_tokens = [f"[cyan]{token}[/]" for token in tokens]
-        formatted_token_string = " and ".join(formatted_tokens)
-
-        rich.print(f"Retrieve your {formatted_token_string} from: {url}")
-        for token in formatted_tokens:
-            prompt = f"Enter your {token} [yellow](hidden)"
-            yield Secret(Prompt.ask(prompt, password=True).strip())
-
-        rich.print()
-
-    @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, Secret(json.loads(value)))
-
-    @model_validator(mode="after")
-    def write_to_keyring(self) -> Self:
-        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(
-            map(
-                Secret[Any].get_secret_value,
-                [
-                    self.tumblr_client_id,
-                    self.tumblr_client_secret,
-                    self.tumblr_token,
-                ],
-            ),
-        ) or Confirm.ask("Reset Tumblr API tokens?", default=False):
-            self.tumblr_client_id, self.tumblr_client_secret = self.online_token_prompt("https://tumblr.com/oauth/apps", "consumer key", "consumer secret")
-
-            oauth = OAuth2Session(
-                self.tumblr_client_id.get_secret_value(),
-                scope=["basic", "write", "offline_access"],
-            )
-            authorization_url, _ = oauth.authorization_url("https://tumblr.com/oauth2/authorize")  # pyright: ignore[reportUnknownMemberType]
-            rich.print(f"Please go to {authorization_url} and authorize access.")
-            self.tumblr_token = Secret(
-                oauth.fetch_token(  # pyright: ignore[reportUnknownMemberType]
-                    "https://api.tumblr.com/v2/oauth2/token",
-                    authorization_response=Prompt.ask("Enter the full callback URL"),
-                    client_secret=self.tumblr_client_secret.get_secret_value(),
-                ),
-            )
-
-        for name, value in self:
-            if isinstance(value, Secret):
-                set_password(self.service_name, name, json.dumps(value.get_secret_value()))
-
-        return self

tumblrbot-1.3.0/src/tumblrbot/utils/models.py

@@ -0,0 +1,131 @@
+from collections.abc import Generator
+from typing import Annotated, Any, ClassVar, Literal, override
+
+import rich
+from keyring import get_password, set_password
+from openai import BaseModel
+from pydantic import ConfigDict, PlainSerializer, SecretStr
+from pydantic.json_schema import SkipJsonSchema
+from requests_oauthlib import OAuth1Session
+from rich.panel import Panel
+from rich.prompt import Confirm, Prompt
+
+
+class FullyValidatedModel(BaseModel):
+    model_config = ConfigDict(
+        extra="ignore",
+        validate_assignment=True,
+        validate_default=True,
+        validate_return=True,
+        validate_by_name=True,
+    )
+
+
+class Tokens(FullyValidatedModel):
+    service_name: ClassVar = "tumblrbot"
+
+    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("")
+
+    @staticmethod
+    def online_token_prompt(url: str, *tokens: str) -> Generator[SecretStr]:
+        formatted_tokens = [f"[cyan]{token}[/]" for token in tokens]
+        formatted_token_string = " and ".join(formatted_tokens)
+
+        rich.print(f"Retrieve your {formatted_token_string} from: {url}")
+        for token in formatted_tokens:
+            prompt = f"Enter your {token} [yellow](hidden)"
+            yield SecretStr(Prompt.ask(prompt, password=True).strip())
+
+        rich.print()
+
+    @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")  # pyright: ignore[reportUnknownMemberType]
+            full_authorize_url = oauth_session.authorization_url("http://tumblr.com/oauth/authorize")  # pyright: ignore[reportUnknownMemberType]
+            (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],
+                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")  # pyright: ignore[reportUnknownMemberType]
+            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(),
+        )
+
+
+class Post(FullyValidatedModel):
+    class Block(FullyValidatedModel):
+        type: str = ""
+        text: str = ""
+        blocks: list[int] = []  # noqa: RUF012
+
+    timestamp: SkipJsonSchema[int] = 0
+    tags: Annotated[list[str], PlainSerializer(",".join)] = []  # noqa: RUF012
+    state: SkipJsonSchema[Literal["published", "queued", "draft", "private", "unapproved"]] = "published"
+
+    content: SkipJsonSchema[list[Block]] = []  # noqa: RUF012
+    layout: SkipJsonSchema[list[Block]] = []  # noqa: RUF012
+    trail: SkipJsonSchema[list[Any]] = []  # noqa: RUF012
+
+    is_submission: SkipJsonSchema[bool] = False
+
+    def __rich__(self) -> Panel:
+        return Panel(
+            self.get_text_content(),
+            title="Preview",
+            subtitle=" ".join(f"#{tag}" for tag in self.tags),
+            subtitle_align="left",
+        )
+
+    @override
+    def model_post_init(self, context: object) -> None:
+        super().model_post_init(context)
+
+        indices: set[int] = set()
+        for block in self.layout:
+            if block.type == "ask":
+                indices.update(block.blocks)
+
+        self.content = [block for i, block in enumerate(self.content) if i not in indices and block.type == "text"]
+
+    def get_text_content(self) -> str:
+        return "\n\n".join(block.text for block in self.content)
+
+
+class Example(FullyValidatedModel):
+    class Message(FullyValidatedModel):
+        role: Literal["developer", "user", "assistant"]
+        content: str
+
+    messages: list[Message]

{tumblrbot-1.2.0 → tumblrbot-1.3.0}/src/tumblrbot/utils/tumblr.py

@@ -1,35 +1,20 @@
 from dataclasses import dataclass
 
-from pydantic import Secret
 from requests import HTTPError, Response
-from requests_oauthlib import OAuth2Session
+from requests_oauthlib import OAuth1Session
 
-from tumblrbot.utils.models import Post
-from tumblrbot.utils.settings import Tokens
+from tumblrbot.utils.models import Post, Tokens
 
 
 @dataclass
-class TumblrClient(OAuth2Session):
+class TumblrClient(OAuth1Session):
     tokens: Tokens
 
     def __post_init__(self) -> None:
-        super().__init__(  # pyright: ignore[reportUnknownMemberType]
-            self.tokens.tumblr_client_id.get_secret_value(),
-            auto_refresh_url="https://api.tumblr.com/v2/oauth2/token",
-            auto_refresh_kwargs={
-                "client_id": self.tokens.tumblr_client_id.get_secret_value(),
-                "client_secret": self.tokens.tumblr_client_secret.get_secret_value(),
-                "token": self.tokens.tumblr_token.get_secret_value(),
-            },
-            token=self.tokens.tumblr_token.get_secret_value(),
-            token_updater=self.token_updater,
-        )
+        super().__init__(*self.tokens.get_tumblr_tokens())  # pyright: ignore[reportUnknownMemberType]
 
         self.hooks["response"].append(self.response_hook)
 
-    def token_updater(self, token: object) -> None:
-        self.tokens.tumblr_token = Secret(token)
-
     def response_hook(self, response: Response, **_: object) -> None:
         try:
             response.raise_for_status()

tumblrbot-1.2.0/PKG-INFO

@@ -1,109 +0,0 @@
-Metadata-Version: 2.4
-Name: tumblrbot
-Version: 1.2.0
-Summary: An updated bot that posts to Tumblr, based on your very own blog!
-Requires-Python: >= 3.13
-Description-Content-Type: text/markdown
-Requires-Dist: keyring
-Requires-Dist: more-itertools
-Requires-Dist: openai
-Requires-Dist: pydantic
-Requires-Dist: pydantic-settings
-Requires-Dist: requests
-Requires-Dist: requests-oauthlib
-Requires-Dist: rich
-Requires-Dist: tiktoken
-Requires-Dist: tomlkit
-Project-URL: Source, https://github.com/MaidThatPrograms/tumblrbot
-
-[OpenAI]: https://pypi.org/project/openai
-[Python]: https://python.org/download
-[Rich]: https://pypi.org/project/rich
-
-[gpt-4.1-nano-2025-04-14]: https://platform.openai.com/docs/models/gpt-4.1-nano
-[Moderation API]: https://platform.openai.com/docs/api-reference/moderations
-[New Post Format]: https://tumblr.com/docs/npf
-[OAuth 2.0]: https://www.tumblr.com/docs/en/api/v2#oauth2-authorization
-[pip]: https://pypi.org
-
-[Download]: tumblrbot/flow/download.py
-[Examples]: tumblrbot/flow/examples.py
-[Fine-Tune]: tumblrbot/flow/fine_tune.py
-[Generate]: tumblrbot/flow/generate.py
-[Settings]: tumblrbot/utils/settings.py
-[Main]: __main__.py
-[README.md]: README.md
-
-# tumblrbot
-[![PyPI - Version](https://img.shields.io/pypi/v/tumblrbot)](https://python.org/pypi/tumblrbot)
-
-Description of original project:
-> 4tv-tumblrbot was a collaborative project I embarked on with my close friend Dima, who goes by @smoqueen on Tumblr. The aim of this endeavor was straightforward yet silly: to develop a Tumblr bot powered by a machine-learning model. This bot would be specifically trained on the content from a particular Tumblr blog or a selected set of blogs, allowing it to mimic the style, tone, and thematic essence of the original posts.
-
-This fork is largely a rewrite of the source code with similarities in its structure and process:
-- Updates:
-   - Updated to [OAuth 2.0].
-   - Updated to the [New Post Format].
-   - Updated to the latest version of [OpenAI].
-   - Updated the [base model version][Settings] to [gpt-4.1-nano-2025-04-14].
-- Removed features:
-   - [Generation][Generate]:
-      - Removed clearing drafts behavior.
-   - [Training][Examples]:
-      - Removed exports that had HTML or reblogs.
-      - Removed special word-replacement behavior.
-      - Removed filtering by year.
-   - Removed setup and related files.
-- Changed/Added features:
-   - [Generation][Generate]:
-      - Added a link to the blog's draft page.
-      - Added error checking for uploading drafts.
-   - [Training][Examples]:
-      - Added the option to [Download] the latest posts from the [specified blogs][Settings].
-      - Added the option to remove posts flagged by the [Moderation API].
-      - Added the option to automatically [Fine-Tune] the examples on the [specified base model][Settings].
-      - Added the ability to add custom prompts and responses to the example data.
-      - Changed to now escape examples automatically.
-      - Set encoding for reading post data to `UTF-8` to fix decoding errors.
-      - Added newlines between paragraphs.
-      - Removed "ALT", submission, ask, and poll text from posts.
-      - Improved the estimated token counts and costs.
-   - Changed to [Rich] for output.
-      - Added progress bars.
-      - Added post previews.
-      - Added color, formatting, and more information to output.
-   - Created a [guided utility][Main] for every step of building your bot blog.
-   - Maid scripts wait for user input before the console closes.
-   - Added comand-line options to override [Settings] options.
-   - Added behavior to regenerate the default [config.toml][Settings] and [env.toml][Settings] if missing.
-   - Renamed several files.
-   - Renamed several [Settings] options.
-   - Changed the value of several [Settings] options.
-   - Added full type-checking coverage (fully importable from third-party scripts).
-
-To-Do:
-- Add documentation.
-- Finish updating [README.md].
-- Change the differences list to instead just be a list of features.
-
-
-**Please submit an issue or contact us for features you want to added/reimplemented.**
-
-## Installation
-1. Install the latest version of [Python]:
-   - Windows: `winget install python3`
-   - Linux (apt): `apt install python-pip`
-   - 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.
-
-## Usage
-Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options.
-
-## Obtaining Tokens
-> WIP
-
-## Configuration
-> WIP
-

tumblrbot-1.2.0/README.md

@@ -1,90 +0,0 @@
-[OpenAI]: https://pypi.org/project/openai
-[Python]: https://python.org/download
-[Rich]: https://pypi.org/project/rich
-
-[gpt-4.1-nano-2025-04-14]: https://platform.openai.com/docs/models/gpt-4.1-nano
-[Moderation API]: https://platform.openai.com/docs/api-reference/moderations
-[New Post Format]: https://tumblr.com/docs/npf
-[OAuth 2.0]: https://www.tumblr.com/docs/en/api/v2#oauth2-authorization
-[pip]: https://pypi.org
-
-[Download]: tumblrbot/flow/download.py
-[Examples]: tumblrbot/flow/examples.py
-[Fine-Tune]: tumblrbot/flow/fine_tune.py
-[Generate]: tumblrbot/flow/generate.py
-[Settings]: tumblrbot/utils/settings.py
-[Main]: __main__.py
-[README.md]: README.md
-
-# tumblrbot
-[![PyPI - Version](https://img.shields.io/pypi/v/tumblrbot)](https://python.org/pypi/tumblrbot)
-
-Description of original project:
-> 4tv-tumblrbot was a collaborative project I embarked on with my close friend Dima, who goes by @smoqueen on Tumblr. The aim of this endeavor was straightforward yet silly: to develop a Tumblr bot powered by a machine-learning model. This bot would be specifically trained on the content from a particular Tumblr blog or a selected set of blogs, allowing it to mimic the style, tone, and thematic essence of the original posts.
-
-This fork is largely a rewrite of the source code with similarities in its structure and process:
-- Updates:
-   - Updated to [OAuth 2.0].
-   - Updated to the [New Post Format].
-   - Updated to the latest version of [OpenAI].
-   - Updated the [base model version][Settings] to [gpt-4.1-nano-2025-04-14].
-- Removed features:
-   - [Generation][Generate]:
-      - Removed clearing drafts behavior.
-   - [Training][Examples]:
-      - Removed exports that had HTML or reblogs.
-      - Removed special word-replacement behavior.
-      - Removed filtering by year.
-   - Removed setup and related files.
-- Changed/Added features:
-   - [Generation][Generate]:
-      - Added a link to the blog's draft page.
-      - Added error checking for uploading drafts.
-   - [Training][Examples]:
-      - Added the option to [Download] the latest posts from the [specified blogs][Settings].
-      - Added the option to remove posts flagged by the [Moderation API].
-      - Added the option to automatically [Fine-Tune] the examples on the [specified base model][Settings].
-      - Added the ability to add custom prompts and responses to the example data.
-      - Changed to now escape examples automatically.
-      - Set encoding for reading post data to `UTF-8` to fix decoding errors.
-      - Added newlines between paragraphs.
-      - Removed "ALT", submission, ask, and poll text from posts.
-      - Improved the estimated token counts and costs.
-   - Changed to [Rich] for output.
-      - Added progress bars.
-      - Added post previews.
-      - Added color, formatting, and more information to output.
-   - Created a [guided utility][Main] for every step of building your bot blog.
-   - Maid scripts wait for user input before the console closes.
-   - Added comand-line options to override [Settings] options.
-   - Added behavior to regenerate the default [config.toml][Settings] and [env.toml][Settings] if missing.
-   - Renamed several files.
-   - Renamed several [Settings] options.
-   - Changed the value of several [Settings] options.
-   - Added full type-checking coverage (fully importable from third-party scripts).
-
-To-Do:
-- Add documentation.
-- Finish updating [README.md].
-- Change the differences list to instead just be a list of features.
-
-
-**Please submit an issue or contact us for features you want to added/reimplemented.**
-
-## Installation
-1. Install the latest version of [Python]:
-   - Windows: `winget install python3`
-   - Linux (apt): `apt install python-pip`
-   - 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.
-
-## Usage
-Run `tumblrbot` from anywhere. Run `tumblrbot --help` for command-line options.
-
-## Obtaining Tokens
-> WIP
-
-## Configuration
-> WIP

tumblrbot-1.2.0/src/tumblrbot/utils/models.py

@@ -1,63 +0,0 @@
-from typing import Annotated, Any, Literal, override
-
-from openai import BaseModel
-from pydantic import ConfigDict, PlainSerializer
-from pydantic.json_schema import SkipJsonSchema
-from rich.panel import Panel
-
-
-class FullyValidatedModel(BaseModel):
-    model_config = ConfigDict(
-        extra="ignore",
-        validate_assignment=True,
-        validate_default=True,
-        validate_return=True,
-        validate_by_name=True,
-    )
-
-
-class Post(FullyValidatedModel):
-    class Block(FullyValidatedModel):
-        type: str = ""
-        text: str = ""
-        blocks: list[int] = []  # noqa: RUF012
-
-    timestamp: SkipJsonSchema[int] = 0
-    tags: Annotated[SkipJsonSchema[list[str]], PlainSerializer(",".join)] = []  # noqa: RUF012
-    state: SkipJsonSchema[Literal["published", "queued", "draft", "private", "unapproved"]] = "published"
-
-    content: SkipJsonSchema[list[Block]] = []  # noqa: RUF012
-    layout: SkipJsonSchema[list[Block]] = []  # noqa: RUF012
-    trail: SkipJsonSchema[list[Any]] = []  # noqa: RUF012
-
-    is_submission: SkipJsonSchema[bool] = False
-
-    def __rich__(self) -> Panel:
-        return Panel(
-            self.get_text_content(),
-            title="Preview",
-            subtitle=" ".join(f"#{tag}" for tag in self.tags),
-            subtitle_align="left",
-        )
-
-    @override
-    def model_post_init(self, context: object) -> None:
-        super().model_post_init(context)
-
-        indices: set[int] = set()
-        for block in self.layout:
-            if block.type == "ask":
-                indices.update(block.blocks)
-
-        self.content = [block for i, block in enumerate(self.content) if i not in indices and block.type == "text"]
-
-    def get_text_content(self) -> str:
-        return "\n\n".join(block.text for block in self.content)
-
-
-class Example(FullyValidatedModel):
-    class Message(FullyValidatedModel):
-        role: Literal["developer", "user", "assistant"]
-        content: str
-
-    messages: list[Message]