omnichar-sdk 0.0.1__tar.gz

omnichar_sdk-0.0.1/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.py[cod]
+.venv*/
+.pytest_cache/
+.ruff_cache/
+dist/

omnichar_sdk-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Aesthisia Datacenters Private Limited
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

omnichar_sdk-0.0.1/PKG-INFO

@@ -0,0 +1,91 @@
+Metadata-Version: 2.5
+Name: omnichar-sdk
+Version: 0.0.1
+Summary: Read Omnichar Studio .char character files: references, description, prompt and LoRA.
+Project-URL: Repository, https://github.com/omnichar/ComfyUI-Omnichar
+Project-URL: Homepage, https://omnichar.org
+Author: Aesthisia Datacenters Private Limited
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: char,character,comfyui,diffusion,lora,omnichar
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Multimedia :: Graphics
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pillow>=10.0; extra == 'dev'
+Requires-Dist: pyright>=1.1.400; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: images
+Requires-Dist: pillow>=10.0; extra == 'images'
+Description-Content-Type: text/markdown
+
+# omnichar-sdk
+
+Read Omnichar Studio `.char` character files from Python.
+
+A `.char` holds a character's reference images, its locked description, and often a trained LoRA.
+This package opens one and hands back those parts. It reads; it never writes.
+
+```python
+from omnichar_sdk import Character
+
+char = Character.open("Ada.char")
+
+char.get_description()                       # the locked description
+char.get_references(arch="flux2-klein")      # the compiled reference set, in prompt order
+char.get_lora()                              # the trained adapter, with a portability verdict
+char.get_prompt(style="ordinal")             # text that binds the character to its positions
+char.save_reference_sheet("ada.png")         # all the references as one numbered PNG
+```
+
+## Reference sheets
+
+`reference_sheet()` lays the references out in a grid and numbers each cell. The numbers are the
+point: a position is what a prompt refers to, so a sheet without them cannot be checked against
+the prompt it belongs to. Pass the same `first_position` to both and they agree.
+
+```python
+char.reference_sheet(arch="flux2-klein", first_position=1)  # a PIL image
+char.reference_sheet_png()                                  # PNG bytes
+char.save_reference_sheet("out/ada.png")                    # writes it, adds .png if missing
+```
+
+It takes the same `arch`, `role`, `limit` and `origin` filters as `get_references`, plus
+`columns`, `cell`, `fit`, `labels` and `background`. It needs the `images` extra.
+
+## Install
+
+```
+pip install omnichar-sdk              # reads everything; needs only the standard library
+pip install 'omnichar-sdk[images]'    # adds Pillow, for decoding and resizing references
+```
+
+The base install has no dependencies on purpose. It is meant to drop into ComfyUI, A1111, SwarmUI
+or a batch job without competing with whatever that host has pinned, so it never converts images to
+tensors. That belongs to the host.
+
+## From a shell
+
+```
+omnichar-sdk inspect Ada.char --json
+omnichar-sdk extract Ada.char -o out/
+omnichar-sdk prompt Ada.char --style token
+```
+
+`inspect --json` prints the whole character record, so a tool in any language can read a `.char`
+through this command without a Python binding.
+
+## The format
+
+`docs/char-format.md` in this repository describes the container and the manifest well enough to
+write a reader in another language.
+
+## Licence
+
+Apache-2.0. The rest of the repository, including the node pack, is GPL-3.0-or-later.

omnichar_sdk-0.0.1/README.md

@@ -0,0 +1,64 @@
+# omnichar-sdk
+
+Read Omnichar Studio `.char` character files from Python.
+
+A `.char` holds a character's reference images, its locked description, and often a trained LoRA.
+This package opens one and hands back those parts. It reads; it never writes.
+
+```python
+from omnichar_sdk import Character
+
+char = Character.open("Ada.char")
+
+char.get_description()                       # the locked description
+char.get_references(arch="flux2-klein")      # the compiled reference set, in prompt order
+char.get_lora()                              # the trained adapter, with a portability verdict
+char.get_prompt(style="ordinal")             # text that binds the character to its positions
+char.save_reference_sheet("ada.png")         # all the references as one numbered PNG
+```
+
+## Reference sheets
+
+`reference_sheet()` lays the references out in a grid and numbers each cell. The numbers are the
+point: a position is what a prompt refers to, so a sheet without them cannot be checked against
+the prompt it belongs to. Pass the same `first_position` to both and they agree.
+
+```python
+char.reference_sheet(arch="flux2-klein", first_position=1)  # a PIL image
+char.reference_sheet_png()                                  # PNG bytes
+char.save_reference_sheet("out/ada.png")                    # writes it, adds .png if missing
+```
+
+It takes the same `arch`, `role`, `limit` and `origin` filters as `get_references`, plus
+`columns`, `cell`, `fit`, `labels` and `background`. It needs the `images` extra.
+
+## Install
+
+```
+pip install omnichar-sdk              # reads everything; needs only the standard library
+pip install 'omnichar-sdk[images]'    # adds Pillow, for decoding and resizing references
+```
+
+The base install has no dependencies on purpose. It is meant to drop into ComfyUI, A1111, SwarmUI
+or a batch job without competing with whatever that host has pinned, so it never converts images to
+tensors. That belongs to the host.
+
+## From a shell
+
+```
+omnichar-sdk inspect Ada.char --json
+omnichar-sdk extract Ada.char -o out/
+omnichar-sdk prompt Ada.char --style token
+```
+
+`inspect --json` prints the whole character record, so a tool in any language can read a `.char`
+through this command without a Python binding.
+
+## The format
+
+`docs/char-format.md` in this repository describes the container and the manifest well enough to
+write a reader in another language.
+
+## Licence
+
+Apache-2.0. The rest of the repository, including the node pack, is GPL-3.0-or-later.

omnichar_sdk-0.0.1/pyproject.toml

@@ -0,0 +1,61 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "omnichar-sdk"
+version = "0.0.1"
+description = "Read Omnichar Studio .char character files: references, description, prompt and LoRA."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Aesthisia Datacenters Private Limited" }]
+keywords = ["omnichar", "char", "character", "lora", "comfyui", "diffusion"]
+# Deliberately empty. The whole point of this package is that it drops into a host's environment
+# without competing with whatever that host has pinned.
+dependencies = []
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Multimedia :: Graphics",
+]
+
+[project.optional-dependencies]
+images = ["Pillow>=10.0"]
+dev = ["pytest>=8.0", "ruff>=0.6", "pyright>=1.1.400", "Pillow>=10.0"]
+
+[project.urls]
+Repository = "https://github.com/omnichar/ComfyUI-Omnichar"
+Homepage = "https://omnichar.org"
+
+[project.scripts]
+omnichar-sdk = "omnichar_sdk.cli:main"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/omnichar_sdk"]
+
+[tool.pyright]
+include = ["src"]
+# Standard, not strict. A manifest is JSON, so every field is dict[str, Any] and strict reports it
+# as partially unknown; the alternative is a TypedDict per field, which would make the reader
+# refuse a valid manifest carrying a key it does not model. Pillow also ships no stubs pyright
+# accepts, and it is an optional extra. Strict was run once and every real finding it produced is
+# fixed; what remained was those two categories alone.
+typeCheckingMode = "standard"
+pythonVersion = "3.10"
+# Named rather than auto-discovered. Pillow is an optional extra, so a pyright that resolves the
+# wrong interpreter reports every PIL import as missing, which is what broke CI while passing here.
+venvPath = "."
+venv = ".venv"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]

omnichar_sdk-0.0.1/src/omnichar_sdk/__init__.py

@@ -0,0 +1,71 @@
+# SPDX-License-Identifier: Apache-2.0
+"""Read Omnichar Studio ``.char`` character files; images need the ``images`` extra."""
+
+from .character import Character, CharacterInfo
+from .charfile import (
+    FORMAT_VERSION,
+    MAGIC,
+    ORIGIN_HARVESTED,
+    ORIGIN_ORIGINAL,
+    ROLE_BODY,
+    ROLE_CLOTH,
+    ROLE_FACE,
+    ROLES,
+    CharChanged,
+    CharDoc,
+    CharError,
+    Manifest,
+    looks_like_char,
+    payload_key,
+    read,
+)
+from .lora import (
+    KEY_SUFFIXES,
+    KEY_WRAPPERS,
+    Lora,
+    Portability,
+    module_stem,
+    safe_output_name,
+)
+from .prompt import STYLES, prompt_prefix
+from .references import FIT_MODES, SIZE_POLICIES, Reference, allocate_roles, common_size, fit_roles
+from .sheet import reference_sheet, sheet_png
+
+__version__ = "0.0.1"
+
+__all__ = [
+    "FIT_MODES",
+    "KEY_SUFFIXES",
+    "KEY_WRAPPERS",
+    "FORMAT_VERSION",
+    "MAGIC",
+    "ORIGIN_HARVESTED",
+    "ORIGIN_ORIGINAL",
+    "ROLES",
+    "ROLE_BODY",
+    "ROLE_CLOTH",
+    "ROLE_FACE",
+    "SIZE_POLICIES",
+    "STYLES",
+    "CharChanged",
+    "CharDoc",
+    "CharError",
+    "Character",
+    "CharacterInfo",
+    "Lora",
+    "Manifest",
+    "Portability",
+    "Reference",
+    "__version__",
+    "allocate_roles",
+    "common_size",
+    "fit_roles",
+    "looks_like_char",
+    "module_stem",
+    "payload_key",
+    "prompt_prefix",
+    "reference_sheet",
+    "sheet_png",
+    "read",
+    "safe_output_name",
+]