novelai-python 0.5.3__tar.gz → 0.6.1__tar.gz

{novelai_python-0.5.3 → novelai_python-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: novelai-python
-Version: 0.5.3
+Version: 0.6.1
 Summary: NovelAI Python Binding With Pydantic
 Author-Email: sudoskys <coldlando@hotmail.com>
 License: Apache License 2.0
@@ -10,7 +10,7 @@ Requires-Python: >=3.9
 Requires-Dist: elara>=0.5.5
 Requires-Dist: loguru>=0.7.2
 Requires-Dist: pydantic-settings>=2.1.0
-Requires-Dist: pydantic>=2.5.3
+Requires-Dist: pydantic>=2.9.0
 Requires-Dist: httpx>=0.26.0
 Requires-Dist: shortuuid>=1.0.11
 Requires-Dist: Pillow>=10.2.0
@@ -49,39 +49,19 @@ The goal of this repository is to use Pydantic to build legitimate requests to a
 
 > Python >= 3.9 is required.
 
-### Roadmap 🚧
+### 📰 News
 
-- [x] tool.random_prompt
-- [x] tool.paint_mask
-- [x] tool.image_metadata
-- [x] tokenizer
-- [x] /ai/generate-image
-- [x] /user/subscription
-- [x] /user/login
-- [x] /user/information
-- [x] /ai/upscale
-- [x] /ai/generate-image/suggest-tags
-- [x] /ai/generate-voice
-- [x] /ai/generate-stream
-- [x] /ai/generate
-- [x] /ai/augment-image
-- [ ] /ai/annotate-image
-- [ ] /ai/classify
-- [ ] /ai/generate-prompt
-
-> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
-> consumption information.
-
-> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+- [Image Generation Model Release — NovelAI Anime Diffusion V4 Curated Preview (EN)](https://blog.novelai.net/release-novelai-anime-diffusion-v4-curated-preview-en-ca4b0b11e671)
+- [Tutorial: Creating Consistent Characters with NovelAI Diffusion Anime [Female]](https://blog.novelai.net/tutorial-en-creating-consistent-characters-with-novelai-diffusion-anime-female-538b4b678a4e)
 
-### Usage 🖥️
+### 📦 Usage
 
 ```shell
 pip -U install novelai-python
 ```
 
-More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
-directory, read code as documentation.
+**More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
+directory, read code as documentation.**
 
 ```python
 import asyncio
@@ -91,17 +71,42 @@ from dotenv import load_dotenv
 from pydantic import SecretStr
 
 from novelai_python import GenerateImageInfer, ImageGenerateResp, ApiCredential
+from novelai_python.sdk.ai.generate_image import Model, Character, Sampler, UCPreset
+from novelai_python.sdk.ai.generate_image.schema import PositionMap
 
 load_dotenv()
-enhance = "year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
 session = ApiCredential(api_token=SecretStr(os.getenv("NOVELAI_JWT")))  # pst-***
 
+prompt = "1girl, year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
+
 
 async def main():
-    gen = await GenerateImageInfer.build(prompt=f"1girl,{enhance}")
+    gen = GenerateImageInfer.build_generate(
+        prompt=prompt,
+        model=Model.NAI_DIFFUSION_4_CURATED_PREVIEW,
+        character_prompts=[
+            Character(
+                prompt="1girl",
+                uc="red hair",
+                center=PositionMap.AUTO
+            ),
+            Character(
+                prompt="1boy",
+                center=PositionMap.E5
+            )
+        ],
+        sampler=Sampler.K_EULER_ANCESTRAL,
+        ucPreset=UCPreset.TYPE0,
+        # Recommended, using preset negative_prompt depends on selected model
+        qualitySuffix=True,
+        qualityToggle=True,
+        decrisp_mode=False,
+        variety_boost=True,
+        # Checkbox in novelai.net
+    )
     cost = gen.calculate_cost(is_opus=True)
     print(f"charge: {cost} if you are vip3")
-    resp = gen.request(session=session)
+    resp = await gen.request(session=session)
     resp: ImageGenerateResp
     print(resp.meta)
     file = resp.files[0]
@@ -114,7 +119,7 @@ loop.run_until_complete(main())
 
 ```
 
-#### LLM
+#### 📦 LLM
 
 ```python
 import asyncio
@@ -165,7 +170,7 @@ loop = asyncio.get_event_loop()
 loop.run_until_complete(chat("Hello"))
 ```
 
-#### Random Prompt
+#### 📦 Random Prompt
 
 ```python
 from novelai_python.tool.random_prompt import RandomPromptGenerator
@@ -174,14 +179,14 @@ prompt = RandomPromptGenerator(nsfw_enabled=False).random_prompt()
 print(prompt)
 ```
 
-#### Run A Server
+#### 📦 Run A Server
 
 ```shell
 pip install novelai_python
 python3 -m novelai_python.server -h '127.0.0.1' -p 7888
 ```
 
-#### Tokenizer
+#### 📦 Tokenizer
 
 ```python
 from novelai_python._enum import get_tokenizer_model, TextLLMModel
@@ -196,7 +201,32 @@ print(tokenizer_package.decode(tokenizer_package.encode(t_text)))
 
 ```
 
-## About Nsfw 🚫
+### 🔨 Roadmap
+
+- [x] tool.random_prompt
+- [x] tool.paint_mask
+- [x] tool.image_metadata
+- [x] tokenizer
+- [x] /ai/generate-image
+- [x] /user/subscription
+- [x] /user/login
+- [x] /user/information
+- [x] /ai/upscale
+- [x] /ai/generate-image/suggest-tags
+- [x] /ai/generate-voice
+- [x] /ai/generate-stream
+- [x] /ai/generate
+- [x] /ai/augment-image
+- [ ] /ai/annotate-image
+- [ ] /ai/classify
+- [ ] /ai/generate-prompt
+
+> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
+> consumption information.
+
+> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+
+## 🚫 About Nsfw
 
 You might need some solutions for identifying NSFW content and adding a mosaic to prevent operational mishaps.
 
@@ -204,7 +234,7 @@ https://dghs-imgutils.deepghs.org/main/api_doc/detect/nudenet.html
 
 https://dghs-imgutils.deepghs.org/main/api_doc/operate/censor.html
 
-## Acknowledgements 🙏
+## 🙏 Acknowledgements
 
 [BackEnd](https://api.novelai.net/docs)
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/README.md

@@ -11,39 +11,19 @@ The goal of this repository is to use Pydantic to build legitimate requests to a
 
 > Python >= 3.9 is required.
 
-### Roadmap 🚧
+### 📰 News
 
-- [x] tool.random_prompt
-- [x] tool.paint_mask
-- [x] tool.image_metadata
-- [x] tokenizer
-- [x] /ai/generate-image
-- [x] /user/subscription
-- [x] /user/login
-- [x] /user/information
-- [x] /ai/upscale
-- [x] /ai/generate-image/suggest-tags
-- [x] /ai/generate-voice
-- [x] /ai/generate-stream
-- [x] /ai/generate
-- [x] /ai/augment-image
-- [ ] /ai/annotate-image
-- [ ] /ai/classify
-- [ ] /ai/generate-prompt
-
-> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
-> consumption information.
-
-> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+- [Image Generation Model Release — NovelAI Anime Diffusion V4 Curated Preview (EN)](https://blog.novelai.net/release-novelai-anime-diffusion-v4-curated-preview-en-ca4b0b11e671)
+- [Tutorial: Creating Consistent Characters with NovelAI Diffusion Anime [Female]](https://blog.novelai.net/tutorial-en-creating-consistent-characters-with-novelai-diffusion-anime-female-538b4b678a4e)
 
-### Usage 🖥️
+### 📦 Usage
 
 ```shell
 pip -U install novelai-python
 ```
 
-More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
-directory, read code as documentation.
+**More examples can be found in the [playground](https://github.com/LlmKira/novelai-python/tree/main/playground)
+directory, read code as documentation.**
 
 ```python
 import asyncio
@@ -53,17 +33,42 @@ from dotenv import load_dotenv
 from pydantic import SecretStr
 
 from novelai_python import GenerateImageInfer, ImageGenerateResp, ApiCredential
+from novelai_python.sdk.ai.generate_image import Model, Character, Sampler, UCPreset
+from novelai_python.sdk.ai.generate_image.schema import PositionMap
 
 load_dotenv()
-enhance = "year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
 session = ApiCredential(api_token=SecretStr(os.getenv("NOVELAI_JWT")))  # pst-***
 
+prompt = "1girl, year 2023,dynamic angle,  best quality, amazing quality, very aesthetic, absurdres"
+
 
 async def main():
-    gen = await GenerateImageInfer.build(prompt=f"1girl,{enhance}")
+    gen = GenerateImageInfer.build_generate(
+        prompt=prompt,
+        model=Model.NAI_DIFFUSION_4_CURATED_PREVIEW,
+        character_prompts=[
+            Character(
+                prompt="1girl",
+                uc="red hair",
+                center=PositionMap.AUTO
+            ),
+            Character(
+                prompt="1boy",
+                center=PositionMap.E5
+            )
+        ],
+        sampler=Sampler.K_EULER_ANCESTRAL,
+        ucPreset=UCPreset.TYPE0,
+        # Recommended, using preset negative_prompt depends on selected model
+        qualitySuffix=True,
+        qualityToggle=True,
+        decrisp_mode=False,
+        variety_boost=True,
+        # Checkbox in novelai.net
+    )
     cost = gen.calculate_cost(is_opus=True)
     print(f"charge: {cost} if you are vip3")
-    resp = gen.request(session=session)
+    resp = await gen.request(session=session)
     resp: ImageGenerateResp
     print(resp.meta)
     file = resp.files[0]
@@ -76,7 +81,7 @@ loop.run_until_complete(main())
 
 ```
 
-#### LLM
+#### 📦 LLM
 
 ```python
 import asyncio
@@ -127,7 +132,7 @@ loop = asyncio.get_event_loop()
 loop.run_until_complete(chat("Hello"))
 ```
 
-#### Random Prompt
+#### 📦 Random Prompt
 
 ```python
 from novelai_python.tool.random_prompt import RandomPromptGenerator
@@ -136,14 +141,14 @@ prompt = RandomPromptGenerator(nsfw_enabled=False).random_prompt()
 print(prompt)
 ```
 
-#### Run A Server
+#### 📦 Run A Server
 
 ```shell
 pip install novelai_python
 python3 -m novelai_python.server -h '127.0.0.1' -p 7888
 ```
 
-#### Tokenizer
+#### 📦 Tokenizer
 
 ```python
 from novelai_python._enum import get_tokenizer_model, TextLLMModel
@@ -158,7 +163,32 @@ print(tokenizer_package.decode(tokenizer_package.encode(t_text)))
 
 ```
 
-## About Nsfw 🚫
+### 🔨 Roadmap
+
+- [x] tool.random_prompt
+- [x] tool.paint_mask
+- [x] tool.image_metadata
+- [x] tokenizer
+- [x] /ai/generate-image
+- [x] /user/subscription
+- [x] /user/login
+- [x] /user/information
+- [x] /ai/upscale
+- [x] /ai/generate-image/suggest-tags
+- [x] /ai/generate-voice
+- [x] /ai/generate-stream
+- [x] /ai/generate
+- [x] /ai/augment-image
+- [ ] /ai/annotate-image
+- [ ] /ai/classify
+- [ ] /ai/generate-prompt
+
+> GenerateImageInfer.calculate_cost is correct in most cases, but please request account information to get accurate
+> consumption information.
+
+> This repo is maintained by me personally now. If you have any questions, please feel free to open an issue.
+
+## 🚫 About Nsfw
 
 You might need some solutions for identifying NSFW content and adding a mosaic to prevent operational mishaps.
 
@@ -166,7 +196,7 @@ https://dghs-imgutils.deepghs.org/main/api_doc/detect/nudenet.html
 
 https://dghs-imgutils.deepghs.org/main/api_doc/operate/censor.html
 
-## Acknowledgements 🙏
+## 🙏 Acknowledgements
 
 [BackEnd](https://api.novelai.net/docs)
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "novelai-python"
-version = "0.5.3"
+version = "0.6.1"
 description = "NovelAI Python Binding With Pydantic"
 authors = [
     { name = "sudoskys", email = "coldlando@hotmail.com" },
@@ -9,7 +9,7 @@ dependencies = [
     "elara>=0.5.5",
     "loguru>=0.7.2",
     "pydantic-settings>=2.1.0",
-    "pydantic>=2.5.3",
+    "pydantic>=2.9.0",
     "httpx>=0.26.0",
     "shortuuid>=1.0.11",
     "Pillow>=10.2.0",

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/__init__.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/1/26 上午10:51
 # @Author  : sudoskys
 # @File    : __init__.py.py
-# @Software: PyCharm
+
 from .ai.generate_image import ImageGenerateResp
 from .user.information import InformationResp
 from .user.login import LoginResp

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/ai/__init__.py

@@ -2,4 +2,4 @@
 # @Time    : 2024/1/26 上午11:20
 # @Author  : sudoskys
 # @File    : __init__.py
-# @Software: PyCharm
+

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/ai/generate_image.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/1/26 上午11:16
 # @Author  : sudoskys
 # @File    : text2image.py
-# @Software: PyCharm
+
 from typing import Tuple, List
 
 from pydantic import BaseModel

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/ai/upscale.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/13 上午11:29
 # @Author  : sudoskys
 # @File    : upscale.py
-# @Software: PyCharm
+
 from typing import Tuple
 
 from pydantic import BaseModel

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/schema.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/13 上午11:30
 # @Author  : sudoskys
 # @File    : schema.py
-# @Software: PyCharm
+
 
 from pydantic import BaseModel
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/user/__init__.py

@@ -2,4 +2,4 @@
 # @Time    : 2024/2/7 上午9:57
 # @Author  : sudoskys
 # @File    : __init__.py.py
-# @Software: PyCharm
+

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/user/information.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/8 下午3:10
 # @Author  : sudoskys
 # @File    : information.py
-# @Software: PyCharm
+
 
 from pydantic import Field
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/user/login.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/7 上午11:57
 # @Author  : sudoskys
 # @File    : login.py
-# @Software: PyCharm
+
 
 from ..schema import RespBase
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/_response/user/subscription.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/7 上午9:57
 # @Author  : sudoskys
 # @File    : subscription.py
-# @Software: PyCharm
+
 from typing import Optional, Dict, Any, List
 
 from pydantic import BaseModel, Field

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/credential/ApiToken.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/8 下午3:05
 # @Author  : sudoskys
 # @File    : ApiToken.py
-# @Software: PyCharm
+
 
 import arrow
 import shortuuid
@@ -18,7 +18,7 @@ class ApiCredential(CredentialBase):
     ApiCredential is the base class for all credential.
     """
     api_token: SecretStr = Field(None, description="api token")
-    _x_correlation_id: str = shortuuid.uuid()[0:6]
+    x_correlation_id: str = shortuuid.uuid()[0:6]
 
     async def get_session(self, timeout: int = 180, update_headers: dict = None):
         headers = {
@@ -29,7 +29,7 @@ class ApiCredential(CredentialBase):
             "Content-Type": "application/json",
             "Origin": "https://novelai.net",
             "Referer": "https://novelai.net/",
-            "x-correlation-id": self._x_correlation_id,
+            "x-correlation-id": self.x_correlation_id,
             "x-initiated-at": f"{arrow.utcnow().isoformat()}Z",
         }
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/credential/JwtToken.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/1/26 上午11:04
 # @Author  : sudoskys
 # @File    : JwtToken.py
-# @Software: PyCharm
+
 
 import arrow
 import shortuuid
@@ -18,7 +18,7 @@ class JwtCredential(CredentialBase):
     JwtCredential is the base class for all credential.
     """
     jwt_token: SecretStr = Field(None, description="jwt token")
-    _x_correlation_id: str = shortuuid.uuid()[0:6]
+    x_correlation_id: str = shortuuid.uuid()[0:6]
 
     async def get_session(self, timeout: int = 180, update_headers: dict = None):
         headers = {
@@ -29,7 +29,7 @@ class JwtCredential(CredentialBase):
             "Content-Type": "application/json",
             "Origin": "https://novelai.net",
             "Referer": "https://novelai.net/",
-            "x-correlation-id": self._x_correlation_id,
+            "x-correlation-id": self.x_correlation_id,
             "x-initiated-at": f"{arrow.utcnow().isoformat()}Z",
         }
 

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/credential/UserAuth.py

@@ -19,9 +19,9 @@ class LoginCredential(CredentialBase):
     """
     username: str = Field(None, description="username")
     password: SecretStr = Field(None, description="password")
-    _session_headers: dict = {}
-    _update_at: Optional[int] = None
-    _x_correlation_id: str = shortuuid.uuid()[0:6]
+    session_headers: dict = Field(default_factory=dict)
+    update_at: Optional[int] = None
+    x_correlation_id: str = shortuuid.uuid()[0:6]
 
     async def get_session(self, timeout: int = 180, update_headers: dict = None):
         headers = {
@@ -32,19 +32,19 @@ class LoginCredential(CredentialBase):
             "Content-Type": "application/json",
             "Origin": "https://novelai.net",
             "Referer": "https://novelai.net/",
-            "x-correlation-id": self._x_correlation_id,
+            "x-correlation-id": self.x_correlation_id,
             "x-initiated-at": f"{arrow.utcnow().isoformat()}Z",
         }
 
         # 30 天有效期
-        if not self._session_headers or int(time.time()) - self._update_at > 29 * 24 * 60 * 60:
+        if not self.session_headers or int(time.time()) - self.update_at > 29 * 24 * 60 * 60:
             from ..sdk import Login
             resp = await Login.build(user_name=self.username, password=self.password.get_secret_value()).request()
             headers["Authorization"] = f"Bearer {resp.accessToken}"
-            self._session_headers = headers
-            self._update_at = int(time.time())
+            self.session_headers = headers
+            self.update_at = int(time.time())
         else:
-            headers.update(self._session_headers)
+            headers.update(self.session_headers)
 
         if update_headers:
             headers.update(update_headers)

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/credential/__init__.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/1/26 上午10:51
 # @Author  : sudoskys
 # @File    : __init__.py.py
-# @Software: PyCharm
+
 from pydantic import SecretStr
 
 from .ApiToken import ApiCredential

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/credential/_base.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/2/7 下午12:14
 # @Author  : sudoskys
 # @File    : _shema.py
-# @Software: PyCharm
+
 from curl_cffi.requests import AsyncSession
 from fake_useragent import UserAgent
 from pydantic import BaseModel

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/sdk/__init__.py

@@ -2,7 +2,7 @@
 # @Time    : 2024/1/26 上午10:51
 # @Author  : sudoskys
 # @File    : __init__.py.py
-# @Software: PyCharm
+
 
 from .ai.augment_image import AugmentImageInfer  # noqa 401
 from .ai.generate import LLM, LLMResp  # noqa 401

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/sdk/ai/__init__.py

@@ -2,4 +2,4 @@
 # @Time    : 2024/1/26 上午11:20
 # @Author  : sudoskys
 # @File    : __init__.py.py
-# @Software: PyCharm
+

{novelai_python-0.5.3 → novelai_python-0.6.1}/src/novelai_python/sdk/ai/_cost.py

@@ -11,9 +11,9 @@ from novelai_python.sdk.ai._enum import Sampler, ModelGroups, get_model_group, M
 class Args(BaseModel):
     height: int
     width: int
-    image: Optional[str]
+    image: bool
     n_samples: int
-    strength: float
+    strength: Optional[float]
     steps: int
     sm: bool
     sm_dyn: bool
@@ -34,11 +34,10 @@ class CostCalculator:
             width: int,
             height: int,
             steps: int,
-            image: str,
+            image: bool,
             n_samples: int,
             account_tier: int,
-            strength: float,
-
+            strength: Optional[float],
             is_sm_enabled: bool,
             is_sm_dynamic: bool,
             is_account_active: bool,
@@ -138,14 +137,15 @@ class CostCalculator:
             dimension = 65536
 
         base_dimension = 1048576
-        strength_multiplier = params.strength if params.image else 1
+        strength_multiplier = params.strength if (isinstance(params.strength, float) and params.image) else 1
         steps = params.steps
         samples = params.n_samples
 
         if steps <= 28 and dimension <= base_dimension and account_tier >= 3 and is_account_active and not is_tool_active:
             samples -= 1
 
-        if model_group and model_group in [ModelGroups.STABLE_DIFFUSION_XL, ModelGroups.STABLE_DIFFUSION_XL_FURRY]:
+        if model_group and model_group in [ModelGroups.STABLE_DIFFUSION_XL, ModelGroups.STABLE_DIFFUSION_XL_FURRY,
+                                           ModelGroups.V4]:
             cost = calculate_dimension_cost(img_width, img_height, steps, params.sm, params.sm_dyn)
         elif dimension <= base_dimension and params.sampler in [
             Sampler.PLMS, Sampler.DDIM,