tumblrbot 1.9.1__tar.gz → 1.9.3__tar.gz

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/.gitignore

@@ -199,7 +199,7 @@ cython_debug/
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
 #  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
-# .vscode/
+.vscode/
 
 # Ruff stuff:
 .ruff_cache/
@@ -215,8 +215,7 @@ __marimo__/
 # Streamlit
 .streamlit/secrets.toml
 
-.vscode
 data
 *.jsonl
-config.toml
+*.toml
 tumblrbot.exe.lnk

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/PKG-INFO

@@ -1,10 +1,9 @@
 Metadata-Version: 2.4
 Name: tumblrbot
-Version: 1.9.1
+Version: 1.9.3
 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: openai
 Requires-Dist: pwinput
 Requires-Dist: pydantic
@@ -25,7 +24,6 @@ Project-URL: Source, https://github.com/MaidScientistIzutsumiMarin/tumblrbot
 [JSON Lines Validator]: https://jsonlines.org/validator
 
 [pip]: https://pypi.org
-[keyring]: https://pypi.org/project/keyring
 [Rich]: https://pypi.org/project/rich
 
 [OpenAI]: https://pypi.org/project/openai
@@ -60,7 +58,6 @@ 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].
    1. Retrieves [Tumblr] [OAuth] tokens.
    1. [Downloads posts][Download] from specified blogs ([configurable]).
       - Skips redownloading already downloaded posts.
@@ -102,7 +99,6 @@ Features:
 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 or use the flag to install packages system-wide.
-   - See [keyring] for additional requirements if you are not on Windows.
 
 ## Usage
 
@@ -174,7 +170,7 @@ Specific Options:
 - **`tags_chance`** - This should be between 0 and 1. Setting it to 0 corresponds to a 0% chance (never) to add tags to a post. 1 corresponds to a 100% chance (always) to add tags to a post. Adding tags incurs a very small token cost.
 - **`reblog_blog_identifiers`** - Whenever a reblog is attempted, a random blog from this list will be chosen to be reblogged from.
 - **`reblog_chance`** - This setting works the same way as `tags_chance`.
-- **`reblog_user_message`** - This setting is a [format string]. The only argument it is formatted with is the content of the post being reblogged. In simple terms, the `{}` will be replaced with said content.
+- **`reblog_user_message`** - This setting is a [format string]. The only argument it is formatted with is the content of the post being reblogged. In simple terms, the `{}` will be replaced with said content. Alternatively, you can leave out the `{}` so that the reblogged post is appended to the end.
   - *Note: The bot is only given the latest message in a reblog chain due to the required complexity and added costs of including the entire chain.*
 
 ## Manual Fine-Tuning

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/README.md

@@ -7,7 +7,6 @@
 [JSON Lines Validator]: https://jsonlines.org/validator
 
 [pip]: https://pypi.org
-[keyring]: https://pypi.org/project/keyring
 [Rich]: https://pypi.org/project/rich
 
 [OpenAI]: https://pypi.org/project/openai
@@ -42,7 +41,6 @@ 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].
    1. Retrieves [Tumblr] [OAuth] tokens.
    1. [Downloads posts][Download] from specified blogs ([configurable]).
       - Skips redownloading already downloaded posts.
@@ -84,7 +82,6 @@ Features:
 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 or use the flag to install packages system-wide.
-   - See [keyring] for additional requirements if you are not on Windows.
 
 ## Usage
 
@@ -156,7 +153,7 @@ Specific Options:
 - **`tags_chance`** - This should be between 0 and 1. Setting it to 0 corresponds to a 0% chance (never) to add tags to a post. 1 corresponds to a 100% chance (always) to add tags to a post. Adding tags incurs a very small token cost.
 - **`reblog_blog_identifiers`** - Whenever a reblog is attempted, a random blog from this list will be chosen to be reblogged from.
 - **`reblog_chance`** - This setting works the same way as `tags_chance`.
-- **`reblog_user_message`** - This setting is a [format string]. The only argument it is formatted with is the content of the post being reblogged. In simple terms, the `{}` will be replaced with said content.
+- **`reblog_user_message`** - This setting is a [format string]. The only argument it is formatted with is the content of the post being reblogged. In simple terms, the `{}` will be replaced with said content. Alternatively, you can leave out the `{}` so that the reblogged post is appended to the end.
   - *Note: The bot is only given the latest message in a reblog chain due to the required complexity and added costs of including the entire chain.*
 
 ## Manual Fine-Tuning

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/pyproject.toml

@@ -1,11 +1,10 @@
 [project]
 name = "tumblrbot"
-version = "1.9.1"
+version = "1.9.3"
 description = "An updated bot that posts to Tumblr, based on your very own blog!"
 readme = "README.md"
 requires-python = ">= 3.13"
 dependencies = [
-  "keyring",
   "openai",
   "pwinput",
   "pydantic",

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/src/tumblrbot/flow/generate.py

@@ -35,6 +35,8 @@ class DraftGenerator(FlowClass):
     def generate_post(self) -> Post:
         if original := self.get_random_post():
             user_message = self.config.reblog_user_message.format(original)
+            if "{}" not in self.config.reblog_user_message:
+                user_message += str(original)
         else:
             original = Post()
             user_message = self.config.user_message
@@ -46,7 +48,6 @@ class DraftGenerator(FlowClass):
         return Post(
             content=[Post.Block(type="text", text=text)],
             tags=tags or [],
-            state="draft",
             parent_tumblelog_uuid=original.blog.uuid,
             parent_post_id=original.id,
             reblog_key=original.reblog_key,

{tumblrbot-1.9.1 → tumblrbot-1.9.3}/src/tumblrbot/utils/models.py

@@ -1,20 +1,17 @@
-import tomllib
-from abc import abstractmethod
 from collections.abc import Generator
 from pathlib import Path
-from typing import Annotated, Any, ClassVar, Literal, Self, override
+from tomllib import loads
+from typing import Annotated, Any, Literal, Self, override
 
 import rich
-import tomlkit
-from keyring import get_password, set_password
 from openai.types import ChatModel
 from pwinput import pwinput
 from pydantic import BaseModel, ConfigDict, Field, NonNegativeFloat, NonNegativeInt, PlainSerializer, PositiveFloat, PositiveInt, model_validator
 from pydantic.json_schema import SkipJsonSchema
 from requests_oauthlib import OAuth1Session
 from rich.panel import Panel
-from rich.prompt import Confirm, Prompt
-from tomlkit import comment, document
+from rich.prompt import Prompt
+from tomlkit import comment, document, dumps  # pyright: ignore[reportUnknownVariableType]
 
 
 class FullyValidatedModel(BaseModel):
@@ -29,22 +26,32 @@ class FullyValidatedModel(BaseModel):
 
 class FileSyncSettings(FullyValidatedModel):
     @classmethod
-    @abstractmethod
-    def read(cls) -> Self | dict[str, object] | str | None: ...
+    def get_toml_file(cls) -> Path:
+        return Path(f"{cls.__name__.lower()}.toml")
 
     @classmethod
     def load(cls) -> Self:
-        data = cls.read() or {}
-        return cls.model_validate_json(data) if isinstance(data, str) else cls.model_validate(data)
+        toml_file = cls.get_toml_file()
+        data = loads(toml_file.read_text("utf_8")) if toml_file.exists() else {}
+        return cls.model_validate(data)
 
     @model_validator(mode="after")
-    @abstractmethod
-    def write(self) -> Self: ...
+    def dump(self) -> Self:
+        toml_table = document()
+
+        for (name, field), value in zip(self.__class__.model_fields.items(), self.model_dump(mode="json").values(), strict=True):
+            if field.description is not None:
+                for line in field.description.split(". "):
+                    toml_table.add(comment(f"{line.removesuffix('.')}."))
 
+            toml_table[name] = value
 
-class Config(FileSyncSettings):
-    toml_file: ClassVar = Path("config.toml")
+        self.get_toml_file().write_text(dumps(toml_table), encoding="utf_8")
 
+        return self
+
+
+class Config(FileSyncSettings):
     # Downloading Posts & Writing Examples
     download_blog_identifiers: list[str] = Field([], description="The identifiers of the blogs which post data will be downloaded from.")
     data_directory: Path = Field(Path("data"), description="Where to store downloaded post data.")
@@ -78,16 +85,10 @@ class Config(FileSyncSettings):
     tags_developer_message: str = Field("You will be provided with a block of text, and your task is to extract a very short list of the most important subjects from it.", description="The developer message used to generate tags.")
     reblog_blog_identifiers: list[str] = Field([], description="The identifiers of blogs that can be reblogged from when generating drafts.")
     reblog_chance: NonNegativeFloat = Field(0.1, description="The chance to generate a reblog of a random post. This will use more OpenAI tokens.")
-    reblog_user_message: str = Field("Please write a comical Tumblr post in response to the following post:\n{}", description="The format string for the user message used to reblog posts.")
-
-    @classmethod
-    @override
-    def read(cls) -> dict[str, object] | None:
-        return tomllib.loads(cls.toml_file.read_text("utf_8")) if cls.toml_file.exists() else None
+    reblog_user_message: str = Field("Please write a comical Tumblr post in response to the following post:\n\n{}", description="The format string for the user message used to reblog posts.")
 
-    @model_validator(mode="after")
     @override
-    def write(self) -> Self:
+    def model_post_init(self, _: object) -> None:
         if not self.download_blog_identifiers:
             rich.print("Enter the [cyan]identifiers of your blogs[/] that data should be [bold purple]downloaded[/] from, separated by commas.")
             self.download_blog_identifiers = list(map(str.strip, Prompt.ask("[bold][Example] [dim]staff.tumblr.com,changes").split(",")))
@@ -96,19 +97,6 @@ class Config(FileSyncSettings):
             rich.print("Enter the [cyan]identifier of your blog[/] that drafts should be [bold purple]uploaded[/] to.")
             self.upload_blog_identifier = Prompt.ask("[bold][Example] [dim]staff.tumblr.com or changes").strip()
 
-        toml_table = document()
-
-        for (name, field), value in zip(self.__class__.model_fields.items(), self.model_dump(mode="json").values(), strict=True):
-            if field.description is not None:
-                for line in field.description.split(". "):
-                    toml_table.add(comment(f"{line.removesuffix('.')}."))
-
-            toml_table[name] = value
-
-        self.toml_file.write_text(tomlkit.dumps(toml_table), encoding="utf_8")
-
-        return self
-
 
 class Tokens(FileSyncSettings):
     class Tumblr(FullyValidatedModel):
@@ -117,39 +105,16 @@ class Tokens(FileSyncSettings):
         resource_owner_key: str = ""
         resource_owner_secret: str = ""
 
-    service_name: ClassVar = "tumblrbot"
-    username: ClassVar = "tokens"
-
     openai_api_key: str = ""
     tumblr: Tumblr = Tumblr()
 
-    @staticmethod
-    def get_oauth_tokens(token: dict[str, str]) -> tuple[str, str]:
-        return token["oauth_token"], token["oauth_token_secret"]
-
-    @staticmethod
-    def online_token_prompt(url: str, *tokens: str) -> Generator[str]:
-        formatted_token_string = " and ".join(f"[cyan]{token}[/]" for token in tokens)
-
-        rich.print(f"Retrieve your {formatted_token_string} from: {url}")
-        for token in tokens:
-            yield pwinput(f"Enter your {token} (masked): ").strip()
-
-        rich.print()
-
-    @classmethod
-    @override
-    def read(cls) -> str | None:
-        return get_password(cls.service_name, cls.username)
-
-    @model_validator(mode="after")
     @override
-    def write(self) -> Self:
+    def model_post_init(self, _: object) -> None:
         # Check if any tokens are missing or if the user wants to reset them, then set tokens if necessary.
-        if not self.openai_api_key or Confirm.ask("Reset OpenAI API key?", default=False):
+        if not self.openai_api_key:
             (self.openai_api_key,) = self.online_token_prompt("https://platform.openai.com/api-keys", "API key")
 
-        if not all(self.tumblr.model_dump().values()) or Confirm.ask("Reset Tumblr API tokens?", default=False):
+        if not all(self.tumblr.model_dump().values()):
             self.tumblr.client_key, self.tumblr.client_secret = self.online_token_prompt("https://tumblr.com/oauth/apps", "consumer key", "consumer secret")
 
             # This is the whole OAuth 1.0 process.
@@ -174,11 +139,19 @@ class Tokens(FileSyncSettings):
 
             self.tumblr.resource_owner_key, self.tumblr.resource_owner_secret = self.get_oauth_tokens(oauth_tokens)
 
-        # Regardless of whether any values were changed, we may as well write to the keyring.
-        # Any unchanged values will be set to the value they already were, since this is run after reading from the keyring.
-        set_password(self.service_name, self.username, self.model_dump_json())
+    @staticmethod
+    def online_token_prompt(url: str, *tokens: str) -> Generator[str]:
+        formatted_token_string = " and ".join(f"[cyan]{token}[/]" for token in tokens)
 
-        return self
+        rich.print(f"Retrieve your {formatted_token_string} from: {url}")
+        for token in tokens:
+            yield pwinput(f"Enter your {token} (masked): ").strip()
+
+        rich.print()
+
+    @staticmethod
+    def get_oauth_tokens(token: dict[str, str]) -> tuple[str, str]:
+        return token["oauth_token"], token["oauth_token_secret"]
 
 
 class Blog(FullyValidatedModel):
@@ -209,7 +182,7 @@ class Post(FullyValidatedModel):
 
     timestamp: SkipJsonSchema[int] = 0
     tags: Annotated[list[str], PlainSerializer(",".join)] = []
-    state: SkipJsonSchema[Literal["published", "queued", "draft", "private", "unapproved"]] = "published"
+    state: SkipJsonSchema[Literal["published", "queued", "draft", "private", "unapproved"]] = "draft"
 
     content: SkipJsonSchema[list[Block]] = []
     layout: SkipJsonSchema[list[Block]] = []