woolpack 0.1.0__tar.gz

woolpack-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 woolroom contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

woolpack-0.1.0/LICENSE-CC0

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

woolpack-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.4
+Name: woolpack
+Version: 0.1.0
+Summary: Standalone validation and authoring tools for Woolroom content packs.
+License-Expression: MIT AND CC0-1.0
+Project-URL: Homepage, https://www.minglongpan.com/projects/woolroom
+Project-URL: Documentation, https://github.com/minglong51/woolroom/blob/main/docs/packs.md
+Project-URL: Issues, https://github.com/minglong51/woolroom/issues
+Project-URL: Repository, https://github.com/minglong51/woolroom
+Project-URL: Pack index, https://github.com/minglong51/woolroom-packs
+Keywords: cli,content-packs,woolroom,yaml
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: LICENSE-CC0
+Requires-Dist: PyYAML>=6.0
+Dynamic: license-file
+
+# Woolpack
+
+Woolpack is the standalone authoring toolkit for
+[Woolroom](https://github.com/minglong51/woolroom) content packs. It scaffolds
+version 1 packs, renders their coats, poses, and hitboxes to a static review
+board, and validates the same fail-closed data contract Woolroom loads at boot.
+
+Packs are local YAML and SVG data. Woolpack does not execute pack code or upload
+pack contents.
+
+## Quick start
+
+Run Woolpack without installing it permanently:
+
+```sh
+uvx woolpack new mole --author "Your Name" --license MIT
+uvx woolpack render packs/mole -o mole-board.html
+uvx woolpack lint packs/mole --strict
+```
+
+The scaffold starts from the bundled Pebble template and renames the species,
+phrase, and quirk identifiers for you. Edit the generated YAML and SVG between
+render and lint runs. Strict lint exits nonzero for either an error or a warning,
+which is the bar intended for registry submissions.
+
+The bundled Pebble template declares `CC0-1.0`. If `--license` is omitted, a
+new pack inherits its source template's license, so choose the intended license
+explicitly when scaffolding original work.
+
+For repeated use, install the command with `uv tool install woolpack`. See the
+[pack format reference](https://github.com/minglong51/woolroom/blob/main/docs/packs.md)
+for the file contract, SVG rig hooks, phrase overlays, and Woolroom boot command.
+The [pack index](https://github.com/minglong51/woolroom-packs) tracks compatible
+pack repositories and defines its submission contract.
+
+## Commands
+
+- `woolpack new <species-id>` scaffolds a pack from the bundled template or a
+  local pack supplied with `--from`.
+- `woolpack render <pack-dir>` validates the pack and writes a self-contained
+  HTML review board.
+- `woolpack lint <pack-dir>` reports contract and authoring-quality findings;
+  `--strict` treats warnings as failures.
+
+Lint checks one pack against Woolpack's bundled format-v1 environment. Woolroom
+revalidates all configured packs together at boot, so cross-pack identifier
+collisions can still make an individually clean pack fail to load.
+
+Woolpack requires Python 3.11 or newer. Its code is licensed under the MIT
+License; the bundled Pebble template is `CC0-1.0`. Both license texts ship with
+the distribution.

woolpack-0.1.0/README.md

@@ -0,0 +1,51 @@
+# Woolpack
+
+Woolpack is the standalone authoring toolkit for
+[Woolroom](https://github.com/minglong51/woolroom) content packs. It scaffolds
+version 1 packs, renders their coats, poses, and hitboxes to a static review
+board, and validates the same fail-closed data contract Woolroom loads at boot.
+
+Packs are local YAML and SVG data. Woolpack does not execute pack code or upload
+pack contents.
+
+## Quick start
+
+Run Woolpack without installing it permanently:
+
+```sh
+uvx woolpack new mole --author "Your Name" --license MIT
+uvx woolpack render packs/mole -o mole-board.html
+uvx woolpack lint packs/mole --strict
+```
+
+The scaffold starts from the bundled Pebble template and renames the species,
+phrase, and quirk identifiers for you. Edit the generated YAML and SVG between
+render and lint runs. Strict lint exits nonzero for either an error or a warning,
+which is the bar intended for registry submissions.
+
+The bundled Pebble template declares `CC0-1.0`. If `--license` is omitted, a
+new pack inherits its source template's license, so choose the intended license
+explicitly when scaffolding original work.
+
+For repeated use, install the command with `uv tool install woolpack`. See the
+[pack format reference](https://github.com/minglong51/woolroom/blob/main/docs/packs.md)
+for the file contract, SVG rig hooks, phrase overlays, and Woolroom boot command.
+The [pack index](https://github.com/minglong51/woolroom-packs) tracks compatible
+pack repositories and defines its submission contract.
+
+## Commands
+
+- `woolpack new <species-id>` scaffolds a pack from the bundled template or a
+  local pack supplied with `--from`.
+- `woolpack render <pack-dir>` validates the pack and writes a self-contained
+  HTML review board.
+- `woolpack lint <pack-dir>` reports contract and authoring-quality findings;
+  `--strict` treats warnings as failures.
+
+Lint checks one pack against Woolpack's bundled format-v1 environment. Woolroom
+revalidates all configured packs together at boot, so cross-pack identifier
+collisions can still make an individually clean pack fail to load.
+
+Woolpack requires Python 3.11 or newer. Its code is licensed under the MIT
+License; the bundled Pebble template is `CC0-1.0`. Both license texts ship with
+the distribution.

woolpack-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "woolpack"
+version = "0.1.0"
+description = "Standalone validation and authoring tools for Woolroom content packs."
+readme = "README.md"
+requires-python = ">=3.11"
+license = "MIT AND CC0-1.0"
+license-files = ["LICENSE", "LICENSE-CC0"]
+keywords = ["cli", "content-packs", "woolroom", "yaml"]
+dependencies = ["PyYAML>=6.0"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+]
+
+[project.urls]
+Homepage = "https://www.minglongpan.com/projects/woolroom"
+Documentation = "https://github.com/minglong51/woolroom/blob/main/docs/packs.md"
+Issues = "https://github.com/minglong51/woolroom/issues"
+Repository = "https://github.com/minglong51/woolroom"
+"Pack index" = "https://github.com/minglong51/woolroom-packs"
+
+[project.scripts]
+woolpack = "woolpack.cli:main"
+
+[build-system]
+requires = ["setuptools>=77"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"woolpack.resources" = [
+    "style.css",
+    "pebble/*.yaml",
+    "pebble/phrases/*.yaml",
+    "pebble/quirks/*.yaml",
+    "pebble/species/*.svg",
+    "pebble/species/*.yaml",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py311"

woolpack-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

woolpack-0.1.0/src/woolpack/__init__.py

@@ -0,0 +1,4 @@
+from woolpack.contract import DEFAULT_ENVIRONMENT, PackEnvironment
+from woolpack.validation import ValidatedPack, validate_pack
+
+__all__ = ["DEFAULT_ENVIRONMENT", "PackEnvironment", "ValidatedPack", "validate_pack"]

woolpack-0.1.0/src/woolpack/cli.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+import argparse
+from importlib.metadata import PackageNotFoundError, version
+
+from woolpack import lint, render, scaffold
+
+
+def _package_version() -> str:
+    try:
+        return version("woolpack")
+    except PackageNotFoundError:
+        return "0.1.0"
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(prog="woolpack", description="Woolpack author tools")
+    parser.add_argument("--version", action="version", version=f"%(prog)s {_package_version()}")
+    commands = parser.add_subparsers(dest="command")
+    commands.add_parser("new", add_help=False, help="scaffold a pack from the Pebble template")
+    commands.add_parser("render", add_help=False, help="render a static visual review board")
+    commands.add_parser("lint", add_help=False, help="validate and lint a pack")
+    args, command_argv = parser.parse_known_args(argv)
+
+    if args.command == "new":
+        return scaffold.main(command_argv, prog="woolpack new")
+    if args.command == "render":
+        return render.main(command_argv, prog="woolpack render")
+    if args.command == "lint":
+        return lint.main(command_argv, prog="woolpack lint")
+    parser.print_help()
+    return 2
+
+
+__all__ = ["main"]
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

woolpack-0.1.0/src/woolpack/contract.py

@@ -0,0 +1,94 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class PackEnvironment:
+    fx_vocab_version: int
+    fx_modes: frozenset[str]
+    quirk_emit_types: frozenset[str]
+    action_ids: frozenset[str]
+    spot_ids: frozenset[str]
+    condition_ids: frozenset[str]
+    pose_keys: frozenset[str]
+    pose_write_ops: frozenset[str]
+    species_ids: frozenset[str]
+    overlay_ids: frozenset[str]
+    quirk_ids: frozenset[str]
+    coat_label_ids: frozenset[str]
+
+
+DEFAULT_ENVIRONMENT = PackEnvironment(
+    fx_vocab_version=1,
+    fx_modes=frozenset(
+        {
+            "greet",
+            "petting",
+            "kibble",
+            "leash_tug",
+            "call_ring",
+            "message_ping",
+            "zoomie",
+            "flinch_away",
+            "petting_melt",
+            "head_tilt",
+            "sigh_settle",
+            "threshold_refusal",
+            "stash",
+            "carry",
+            "lean_in",
+            "side_eye",
+            "ignored",
+            "petting_head",
+            "petting_ear",
+            "petting_tail",
+            "petting_belly",
+            "warm_spot",
+            "brushed_coat",
+            "bowl",
+            "leash",
+            "phone_glow",
+            "rumpled_rug",
+        }
+    ),
+    quirk_emit_types=frozenset({"response"}),
+    action_ids=frozenset({"greet", "feed", "pet", "walk", "call", "message", "play"}),
+    spot_ids=frozenset({"body", "head", "ear", "tail", "belly"}),
+    condition_ids=frozenset(
+        {
+            "action_in",
+            "state_in",
+            "state_not_in",
+            "valence_gte",
+            "valence_lt",
+            "arousal_gte",
+            "arousal_lt",
+            "old_arousal_lt",
+            "old_valence_lt",
+            "enters_state",
+            "fact_day_gate",
+            "fact_exists",
+            "any",
+        }
+    ),
+    pose_keys=frozenset(
+        {"body_lean", "head_shift_y", "ear_angle", "eye_style", "tail_motion", "focus_target"}
+    ),
+    pose_write_ops=frozenset({"set", "min", "set_if_default"}),
+    species_ids=frozenset({"cat"}),
+    overlay_ids=frozenset(),
+    quirk_ids=frozenset(
+        {
+            "hides_small_things",
+            "threshold_refuser",
+            "one_eye_napper",
+            "lean_in_greeter",
+            "content_sigher",
+            "fixated_watcher",
+            "zoomie_initiator",
+            "side_eye_judge",
+        }
+    ),
+    coat_label_ids=frozenset({"tuxedo", "marmalade", "ash"}),
+)