fbxkit 0.1.0__tar.gz

fbxkit-0.1.0/.gitignore

@@ -0,0 +1,33 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.eggs/
+
+# Environments
+.venv/
+venv/
+env/
+
+# Tooling
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+
+# Editors
+.idea/
+.vscode/
+*.swp
+
+# OS
+.DS_Store
+Thumbs.db
+
+# Scratch output from the examples and the test scripts
+*.fbx
+!tests/data/*.fbx
+.fbxkit-*

fbxkit-0.1.0/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project are documented here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and the project uses
+[semantic versioning](https://semver.org/).
+
+Note that the **package version and the schema version move independently**.
+`fbxkit.SCHEMA_VERSION` describes the shape of the documents and patches; pin
+consumers to that rather than to the release.
+
+## [0.1.0] - 2026-09-01
+
+First release. Schema `0.1.0`.
+
+### Added
+
+- `fbxkit.open()` / `new()` / `read()` / `patch_file()` -- the four entry points.
+- **Selectors**: `|root|**[type=mesh]`, `**|*_L`, `[name~=regex]`, with `**`
+  spanning any depth and `#N` disambiguating duplicate sibling names.
+- **Nine builtin operations**, deliberately few: `create_node`, `delete_node`,
+  `rename`, `reparent`, `set_property`, `add_property`, `remove_property`,
+  `set_transform`, `retarget_textures`. Each is something you can ask of any
+  FBX file. Scene settings are readable but not writable -- see below.
+- **Patches as data**: a JSON file of operations that can be stored, reviewed,
+  validated without opening a scene, dry-run, and applied identically on a
+  workstation and on a server.
+- **`FbxSession` / `FakeSession`** behind one protocol, so the whole package is
+  tested with no SDK installed.
+- **A versioned document schema** with lossless round trips: fields written by a
+  newer fbxkit survive being read and rewritten by an older one.
+- **`fbxkit` CLI**: `info`, `ls`, `read`, `apply`, `do`, `ops`, `validate`,
+  `demo`, `doctor`, with exit codes `0` / `1` / `2`.
+- **`fbxkit doctor`** -- the Autodesk SDK is a required external dependency that
+  cannot be declared in `pyproject.toml` (not on PyPI, one wheel per CPython
+  minor version). `doctor` reports whether this interpreter has it, searches the
+  usual install locations, and prints the exact wheel path and `pip install`
+  line, or says why the wheel present is for a different Python.
+- **A test corpus and the scripts that produce it**: `make_test_fbx.py` writes
+  16 FBX files covering every edge case below, with a `manifest.json` recording
+  what each pins down and what opening it actually did; `verify_testdata.py`
+  checks a directory against that manifest (bytes and behaviour);
+  `publish_testdata.py` publishes it to Subversion, idempotently.
+- **`scripts/release.py`** -- builds and publishes to PyPI with the whole gate in
+  front of the upload, and refuses a version number that the index already has:
+  that is the one mistake here that cannot be undone.
+
+### Notes on behaviour that came out of measurement
+
+- Saves preserve the input's **format and FBX version** by default. The format
+  is sniffed from the file header because `FbxImporter.GetFileFormat()` reports
+  binary for ASCII files.
+- Export version strings are checked against a whitelist because
+  `SetFileExportVersion()` returns `True` for versions that do not exist.
+- Deletion is recursive by default: the SDK's non-recursive destroy leaves
+  children alive but unparented, and the exporter writes them back out.
+- Writes are atomic -- a temporary file beside the target, moved into place. The
+  cost, taken deliberately: the exporter stamps the path it was given into the
+  file as `DocumentUrl`, and that cannot be overridden, so the temporary name is
+  what gets recorded. It is derived from the target to stay recognisable.
+- A failed patch is not saved, so a file is either fully patched or untouched.
+- A file that opens with **zero nodes** is flagged: a truncated ASCII FBX imports
+  without complaint and yields an empty scene, so "empty" and "damaged" are
+  otherwise indistinguishable.
+- FBX export is **not reproducible** -- the header carries a creation timestamp
+  and the document path, so saving the same scene twice gives different bytes.
+- Scene settings are readable but **not writable**. Changing the declared axis or
+  unit without re-transforming the geometry is half a conversion, and an MVP
+  should not ship the half that silently misplaces assets.

fbxkit-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 narutozb
+
+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.