colemen-py 0.1.0__tar.gz

colemen_py-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

colemen_py-0.1.0/MANIFEST.in

@@ -0,0 +1,13 @@
+include LICENSE
+include README.md
+include pyproject.toml
+recursive-include docs *.md
+recursive-include src/colemen_py/domains/constants/data *.json *.jsonc *.txt
+recursive-include src/colemen_py/binaries *.exe .gitkeep
+recursive-exclude * __pycache__
+recursive-exclude * *.py[cod]
+recursive-exclude * *.pyo
+recursive-exclude * .pytest_cache
+prune build
+prune dist
+prune src/colemen_py.egg-info

colemen_py-0.1.0/PKG-INFO

@@ -0,0 +1,122 @@
+Metadata-Version: 2.4
+Name: colemen-py
+Version: 0.1.0
+Summary: A dot-accessible Python utility toolkit for files, directories, media, math conversions, random values, strings, validation, and external tooling.
+Author: Colemen Atwood
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/r146023/colemen_py
+Project-URL: Repository, https://github.com/r146023/colemen_py
+Project-URL: Issues, https://github.com/r146023/colemen_py/issues
+Project-URL: Documentation, https://github.com/r146023/colemen_py/tree/main/docs
+Keywords: utilities,files,directories,media,metadata,math,conversion,strings,validation,automation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: python-dateutil>=2.8.2
+Provides-Extra: image
+Requires-Dist: Pillow>=10; extra == "image"
+Provides-Extra: audio
+Requires-Dist: mutagen>=1.47; extra == "audio"
+Provides-Extra: video
+Requires-Dist: opencv-python>=4.8; extra == "video"
+Provides-Extra: media
+Requires-Dist: Pillow>=10; extra == "media"
+Requires-Dist: mutagen>=1.47; extra == "media"
+Requires-Dist: opencv-python>=4.8; extra == "media"
+Provides-Extra: windows
+Requires-Dist: win32-setctime>=1.1; platform_system == "Windows" and extra == "windows"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=5; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: twine>=5; extra == "dev"
+Dynamic: license-file
+
+# colemen_py
+
+`colemen_py` is a dot-accessible Python utility toolkit rebuilt from the older `colemen_utils` ecosystem.
+
+The public API is intentionally discoverable from a single import:
+
+```python
+import colemen_py as c
+
+c.file.exists("notes.txt")
+c.string.to_snake_case("Hello World")
+c.rand.uuid()
+```
+
+
+## Installation
+
+Base install:
+
+```bash
+pip install colemen-py
+```
+
+Optional feature groups:
+
+```bash
+pip install "colemen-py[image]"   # Pillow-backed image helpers
+pip install "colemen-py[audio]"   # Mutagen-backed audio metadata helpers
+pip install "colemen-py[video]"   # OpenCV-backed video frame scoring helpers
+pip install "colemen-py[media]"   # image + audio + video optional dependencies
+pip install "colemen-py[dev]"     # test/build/lint tooling
+```
+
+The import package name is still `colemen_py`:
+
+```python
+import colemen_py as c
+```
+
+## Design principles
+
+- One installable package, many internal modules.
+- Dot-accessible namespaces for IDE autocomplete.
+- Pythonic `snake_case` method names, with selected compatibility aliases where useful.
+- Public functions include type hints and docstrings.
+- No expensive work at import time.
+- `str` and `pathlib.Path` are accepted for path-based helpers.
+- Generic file utilities live in `c.file`; media-specific behavior lives in `c.media`.
+
+## Public namespaces
+
+```python
+c.array      # list/sequence utilities
+c.list       # alias to c.array
+c.object     # dictionary/object utilities
+c.dict       # alias to c.object
+c.string     # string utilities
+c.file       # file utilities
+c.dir        # directory utilities
+c.directory  # alias to c.dir
+c.console    # console output/timers
+c.rand       # random values/ids
+c.random     # alias to c.rand
+c.time       # time/duration utilities
+c.type       # type checks/coercion
+c.validation # validation helpers
+c.math       # math helpers
+c.media      # media/binary utilities
+```
+
+## Stage 1 status
+
+This is the foundation package. The old `colemen_utils` source has not been blindly copied in. Instead, the core utility surface has been rebuilt with clean internals and tests.
+
+The package can use bundled binaries when present and can also fall back to compatible tools available on `PATH`. Current media wrappers may rely on external executables such as ExifTool, FFmpeg, FFprobe, `colemen_copy`, and Shredator depending on the feature being used.

colemen_py-0.1.0/README.md

@@ -0,0 +1,75 @@
+# colemen_py
+
+`colemen_py` is a dot-accessible Python utility toolkit rebuilt from the older `colemen_utils` ecosystem.
+
+The public API is intentionally discoverable from a single import:
+
+```python
+import colemen_py as c
+
+c.file.exists("notes.txt")
+c.string.to_snake_case("Hello World")
+c.rand.uuid()
+```
+
+
+## Installation
+
+Base install:
+
+```bash
+pip install colemen-py
+```
+
+Optional feature groups:
+
+```bash
+pip install "colemen-py[image]"   # Pillow-backed image helpers
+pip install "colemen-py[audio]"   # Mutagen-backed audio metadata helpers
+pip install "colemen-py[video]"   # OpenCV-backed video frame scoring helpers
+pip install "colemen-py[media]"   # image + audio + video optional dependencies
+pip install "colemen-py[dev]"     # test/build/lint tooling
+```
+
+The import package name is still `colemen_py`:
+
+```python
+import colemen_py as c
+```
+
+## Design principles
+
+- One installable package, many internal modules.
+- Dot-accessible namespaces for IDE autocomplete.
+- Pythonic `snake_case` method names, with selected compatibility aliases where useful.
+- Public functions include type hints and docstrings.
+- No expensive work at import time.
+- `str` and `pathlib.Path` are accepted for path-based helpers.
+- Generic file utilities live in `c.file`; media-specific behavior lives in `c.media`.
+
+## Public namespaces
+
+```python
+c.array      # list/sequence utilities
+c.list       # alias to c.array
+c.object     # dictionary/object utilities
+c.dict       # alias to c.object
+c.string     # string utilities
+c.file       # file utilities
+c.dir        # directory utilities
+c.directory  # alias to c.dir
+c.console    # console output/timers
+c.rand       # random values/ids
+c.random     # alias to c.rand
+c.time       # time/duration utilities
+c.type       # type checks/coercion
+c.validation # validation helpers
+c.math       # math helpers
+c.media      # media/binary utilities
+```
+
+## Stage 1 status
+
+This is the foundation package. The old `colemen_utils` source has not been blindly copied in. Instead, the core utility surface has been rebuilt with clean internals and tests.
+
+The package can use bundled binaries when present and can also fall back to compatible tools available on `PATH`. Current media wrappers may rely on external executables such as ExifTool, FFmpeg, FFprobe, `colemen_copy`, and Shredator depending on the feature being used.

colemen_py-0.1.0/docs/domains/directories/directory-api-reference.md

@@ -0,0 +1,90 @@
+# DirectoryAPI reference
+
+`DirectoryAPI` is the dot-access namespace exported as `directory`.
+
+## Public methods
+
+| Name | Signature | Purpose |
+|---|---|---|
+| `exists` | `exists(self, path: PathLike)` | Return True if ``path`` exists and is a directory. |
+| `ensure` | `ensure(self, path: PathLike, dir_name: str \| bool=False)` | Create a directory if it does not already exist and return it. |
+| `info` | `info(self, path: PathLike, *, must_exist: bool=True)` | Return a ``DirectoryInfo`` object. |
+| `get_data` | `get_data(self, path: PathLike, *, include: Iterable[str] \| None=None)` | Return legacy-friendly directory data. |
+| `delete` | `delete(self, path: PathLike, *, missing_ok: bool=True, persistent: bool=False)` | Delete a directory recursively. |
+| `empty` | `empty(self, path: PathLike, *, create: bool=True)` | Remove all contents from a directory while keeping the directory itself. |
+| `files` | `files(self, path: PathLike, *, recursive: bool=False, exclude: str \| Iterable[str] \| None=None, include: str \| Iterable[str] \| None=None, extensions: str \| Iterable[str] \| None=None, return_data: bool=False)` | Return files contained by a directory. |
+| `dirs` | `dirs(self, path: PathLike='.', *, recursive: bool=False, exclude: str \| Iterable[str] \| None=None, include: str \| Iterable[str] \| None=None, use_objects: bool=False, paths_only: bool=False)` | Return child directories. |
+| `objects` | `objects(self, path: PathLike='.', *, recursive: bool=True, exclude: str \| Iterable[str] \| None=None, include: str \| Iterable[str] \| None=None)` | Return folders as ``DirectoryInfo`` objects. |
+| `walk` | `walk(self, path: PathLike)` | Yield ``os.walk``-style tuples using POSIX string paths. |
+| `copy` | `copy(self, src: PathLike, dst: PathLike, **kwargs)` | Copy/mirror a directory to another location. |
+| `mirror` | `mirror(self, src: PathLike, dst: PathLike, **kwargs)` | Mirror a directory tree to another location. |
+| `copy_with_colemen_copy` | `copy_with_colemen_copy(self, src: PathLike, dst: PathLike, **kwargs)` | Copy a directory tree through the colemen_copy external engine. |
+| `mirror_with_colemen_copy` | `mirror_with_colemen_copy(self, src: PathLike, dst: PathLike, **kwargs)` | Mirror a directory tree through the colemen_copy external engine. |
+| `move_with_colemen_copy` | `move_with_colemen_copy(self, src: PathLike, dst: PathLike, **kwargs)` | Move a directory tree through the colemen_copy external engine. |
+| `clone_structure` | `clone_structure(self, src: PathLike, dst: PathLike, **kwargs)` | Create a zero-byte skeleton tree through the colemen_copy external engine. |
+| `sync_child_folders` | `sync_child_folders(self, src: PathLike, dst: PathLike, **kwargs)` | Mirror direct child folders through the colemen_copy external engine. |
+| `move` | `move(self, src: PathLike, dst: PathLike, *, overwrite: bool=True)` | Move a directory to another path. |
+| `create_zip` | `create_zip(self, src: PathLike, dst: PathLike \| None=None, *, delete_after: bool=False, overwrite: bool=True, timestamps: bool=True)` | Create a zip archive from a directory. |
+| `by_name` | `by_name(self, dir_name: str \| Iterable[str], search_path: PathLike='.', *, recursive: bool=True, case_sensitive: bool=True, exact_match: bool=True, regex: bool=False)` | Search for directories by name. |
+| `size` | `size(self, path: PathLike)` | Return the total size of contained files in bytes. |
+| `content_hash` | `content_hash(self, path: PathLike)` | Return a hash of contained file paths/sizes/modified times. |
+
+## Common aliases
+
+| Canonical | Aliases |
+|---|---|
+| `exists()` | `is_dir()` |
+| `ensure()` | `create()`, `mkdir()` |
+| `info()` | `get_folder()` |
+| `empty()` | `clear()` |
+| `files()` | `get_files()` |
+| `dirs()` | `get_folders()`, `folders()` |
+| `objects()` | `get_folders_obj()` |
+| `copy_with_colemen_copy()` | `copy_tree()`, `engine_copy()` |
+| `mirror_with_colemen_copy()` | `mirror_tree()`, `engine_mirror()` |
+| `move_with_colemen_copy()` | `move_tree()`, `engine_move()` |
+| `clone_structure()` | `clone_structure_with_colemen_copy()` |
+| `sync_child_folders()` | `sync_child_folders_with_colemen_copy()` |
+| `create_zip()` | `zip()` |
+| `by_name()` | `search_by_name()` |
+
+## Practical usage
+
+```python
+# Create folders.
+c.directory.ensure("K:/Archive/Images")
+c.directory.ensure("K:/Archive", dir_name="Images")
+
+# Empty a folder but keep the folder.
+c.directory.empty("K:/Archive/_temp")
+
+# Delete recursively.
+c.directory.delete("K:/Archive/_old", missing_ok=True)
+
+# Inspect.
+info = c.directory.info("K:/Archive")
+print(info.name, info.size, info.content_hash)
+
+# Walk.
+for root, dirs, files in c.directory.walk("K:/Archive"):
+    print(root, len(dirs), len(files))
+```
+
+## Local mirror/copy
+
+`copy()` is an alias for the local `mirror()` implementation.
+
+```python
+c.directory.copy("K:/Source", "D:/Backup/Source")
+c.directory.mirror("K:/Source", "D:/Backup/Source")
+```
+
+## External engine copy/mirror/move
+
+```python
+c.directory.copy_with_colemen_copy("K:/Source", "D:/Backup/Source")
+c.directory.mirror_with_colemen_copy("K:/Source", "D:/Backup/Source")
+c.directory.move_with_colemen_copy("K:/Source", "D:/Archive/Source")
+```
+
+These methods require the external `colemen_copy` integration to exist in the full project.

colemen_py-0.1.0/docs/domains/directories/directory-info.md

@@ -0,0 +1,140 @@
+# `DirectoryInfo` object
+
+`DirectoryInfo` wraps one directory path and provides lazy size/files lookup, timestamps, child folder/file helpers, archive helpers, and external-engine convenience methods.
+
+## Construction
+
+```python
+info = c.directory.info("K:/Archive")
+
+from colemen_py.domains.directories import DirectoryInfo
+info = DirectoryInfo("K:/Archive")
+```
+
+## Public methods
+
+| Name | Signature | Purpose |
+|---|---|---|
+| `file_path` | `file_path(self)` | Directory path as a POSIX-style string. |
+| `dir_path` | `dir_path(self)` | Parent directory path as a POSIX-style string. |
+| `name` | `name(self)` | Directory name. |
+| `drive` | `drive(self)` | Drive or anchor for the directory path. |
+| `exists` | `exists(self)` | Return True when the directory exists. |
+| `modified` | `modified(self)` | Directory modified timestamp. |
+| `modified` | `modified(self, value: float \| datetime)` |  |
+| `accessed` | `accessed(self)` | Directory accessed timestamp. |
+| `accessed` | `accessed(self, value: float \| datetime)` |  |
+| `created` | `created(self)` | Directory created/change timestamp reported by the OS. |
+| `modified_datetime` | `modified_datetime(self)` | Modified timestamp as a ``datetime``. |
+| `accessed_datetime` | `accessed_datetime(self)` | Accessed timestamp as a ``datetime``. |
+| `created_datetime` | `created_datetime(self)` | Created/change timestamp as a ``datetime``. |
+| `modified_mdy` | `modified_mdy(self)` | Modified date formatted as MM-DD-YYYY. |
+| `accessed_mdy` | `accessed_mdy(self)` | Accessed date formatted as MM-DD-YYYY. |
+| `created_mdy` | `created_mdy(self)` | Created/change date formatted as MM-DD-YYYY. |
+| `size` | `size(self)` | Total size of files contained by this directory, in bytes. |
+| `files` | `files(self)` | Immediate child files as ``FileInfo`` objects. |
+| `get_files` | `get_files(self, *, recursive: bool=False, exclude: str \| Iterable[str] \| None=None, include: str \| Iterable[str] \| None=None, extensions: str \| Iterable[str] \| None=None)` | Return files contained by this directory. |
+| `get_dirs` | `get_dirs(self, *, recursive: bool=False, exclude: str \| Iterable[str] \| None=None, include: str \| Iterable[str] \| None=None)` | Return child directories as ``DirectoryInfo`` objects. |
+| `has_file` | `has_file(self, file_name: str)` | Return a matching immediate child file, or False. |
+| `most_recent_modification` | `most_recent_modification(self)` | Most recent modified timestamp among all contained files. |
+| `content_hash` | `content_hash(self)` | Stable-ish hash of contained file paths, sizes, and modified times. |
+| `summary` | `summary(self)` | Legacy-friendly summary dictionary. |
+| `to_dict` | `to_dict(self, include: Iterable[str] \| None=None)` | Return selected directory data as a dictionary. |
+| `create_zip` | `create_zip(self, file_name: str \| None=None, *, delete_after: bool=False, overwrite: bool=True, timestamps: bool=True)` | Create a zip archive from this directory. |
+| `delete` | `delete(self, *, missing_ok: bool=True)` | Delete this directory recursively. |
+| `copy_to` | `copy_to(self, destination: PathLike, **kwargs)` | Copy this directory with the colemen_copy external engine. |
+| `mirror_to` | `mirror_to(self, destination: PathLike, **kwargs)` | Mirror this directory with the colemen_copy external engine. |
+| `move_to` | `move_to(self, destination: PathLike, **kwargs)` | Move this directory with the colemen_copy external engine. |
+| `clone_structure_to` | `clone_structure_to(self, destination: PathLike, **kwargs)` | Create a zero-byte skeleton of this directory with colemen_copy. |
+| `sync_child_folders_to` | `sync_child_folders_to(self, destination: PathLike, **kwargs)` | Mirror this directory's direct child folders with colemen_copy. |
+| `shred` | `shred(self, *, passes: int=3, pattern: str='random', force: bool=True, zero_names: bool=False, strict_warnings: bool=False, missing_ok: bool=True, verify: bool=True, timeout: float \| None=None, binary_path: PathLike \| None=None)` | Securely delete this directory through the Shredator external engine. |
+
+## Core properties
+
+```python
+info.file_path      # POSIX-style directory path
+info.dir_path       # parent directory path
+info.name           # directory name
+info.drive          # drive or anchor
+info.exists         # True if directory exists
+info.size           # recursive byte size of contained files
+info.content_hash   # sha256 hash of file paths/sizes/modified times
+info.summary        # dictionary
+```
+
+## Timestamps
+
+```python
+info.modified
+info.accessed
+info.created
+
+info.modified_datetime
+info.accessed_datetime
+info.created_datetime
+
+info.modified_mdy
+info.accessed_mdy
+info.created_mdy
+```
+
+`modified` and `accessed` are writable through `os.utime()`:
+
+```python
+from datetime import datetime
+
+info.modified = datetime(2024, 6, 1, 12, 0, 0)
+info.accessed = 1717243200.0
+```
+
+## Files and child folders
+
+```python
+# Immediate child files cached on first access.
+files = info.files
+
+# Explicit scans.
+all_images = info.get_files(recursive=True, extensions="image")
+child_dirs = info.get_dirs(recursive=False)
+```
+
+`has_file()` checks immediate child files by exact file name or by stem when no extension is provided:
+
+```python
+match = info.has_file("notes.txt")
+match = info.has_file("notes")
+
+if match:
+    print(match.file_path)
+```
+
+## Most recent modification
+
+```python
+latest = info.most_recent_modification
+```
+
+This returns the newest modified timestamp among the directory itself and all contained files.
+
+## Dictionary output
+
+```python
+info.to_dict()
+info.to_dict(["file_path", "name", "size"])
+info.data_as_dict()
+```
+
+## Operations
+
+```python
+info.create_zip()
+info.delete()
+info.copy_to("D:/Backup/Archive")
+info.mirror_to("D:/Mirror/Archive")
+info.move_to("D:/ArchiveMoved")
+info.clone_structure_to("D:/Skeleton/Archive")
+info.sync_child_folders_to("D:/BackupChildren")
+info.shred()
+```
+
+The external-engine methods call `colemen_copy` or Shredator integrations when available.