agent-folder-workspace 0.1.0__tar.gz

agent_folder_workspace-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,77 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+env:
+  PIP_DISABLE_PIP_VERSION_CHECK: "1"
+  PYTHONUTF8: "1"
+
+jobs:
+  quality-and-distribution:
+    name: ${{ matrix.os }} / Python ${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: windows-latest
+            python: "3.11"
+          - os: windows-latest
+            python: "3.12"
+          - os: windows-latest
+            python: "3.13"
+          - os: windows-latest
+            python: "3.14"
+          - os: ubuntu-latest
+            python: "3.11"
+          - os: ubuntu-latest
+            python: "3.14"
+          - os: macos-latest
+            python: "3.11"
+          - os: macos-latest
+            python: "3.14"
+
+    steps:
+      - name: Check out source
+        uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+
+      - name: Install project and development tools
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install --group dev "hatchling>=1.27" -e .
+
+      - name: Check committed JSON Schemas
+        run: python scripts/generate_json_schemas.py --check
+
+      - name: Lint
+        run: ruff check .
+
+      - name: Type-check
+        run: mypy
+
+      - name: Test
+        run: pytest
+
+      - name: Build sdist and wheel
+        env:
+          SOURCE_DATE_EPOCH: "315532800"
+        run: python -m build --no-isolation
+
+      - name: Validate and install wheel
+        run: python scripts/check_wheel.py dist --install-smoke
+
+      - name: Verify reproducible wheel build
+        run: python scripts/check_wheel.py --reproducible

agent_folder_workspace-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+.coverage
+.hypothesis/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.venv/
+__pycache__/
+build/
+dist/
+*.egg-info/

agent_folder_workspace-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,157 @@
+# Contributing
+
+Contributions should preserve the project's main invariants: offline and
+read-only normal operation, lazy payload access, stable versioned contracts,
+bounded output, deterministic packaging, and explicit honest limitations.
+
+## Development setup
+
+Use Python 3.11 or newer (3.11 through 3.14 are supported) and a current `pip`:
+
+```console
+python -m venv .venv
+.venv/bin/python -m pip install --upgrade pip
+.venv/bin/python -m pip install --group dev "hatchling>=1.27" -e .
+```
+
+On Windows, replace `.venv/bin/python` with
+`.venv\Scripts\python.exe`; [docs/windows.md](docs/windows.md) has the complete
+PowerShell workflow.
+
+## Change workflow
+
+1. State the user-visible behavior and its security/resource boundaries.
+2. Add or adjust the smallest test first and run it to observe the expected
+   failure.
+3. Implement only enough behavior to pass, then refactor while tests remain
+   green.
+4. Update README, architecture, format matrix, Windows notes, or security policy
+   when the observable contract or limitation changed.
+5. Run the complete gate below and include relevant command output in the pull
+   request.
+
+Keep fixtures generated and minimal. Do not commit customer documents,
+credentials, personal paths, licensed document samples, crash dumps, Office
+recent-file state, or caches.
+
+## Code style
+
+- Target the Python 3.11 language level unless a guarded compatibility reason
+  requires otherwise.
+- Keep public methods typed and return versioned models rather than ad-hoc
+  dictionaries where a wire contract exists.
+- Prefer small adapters with deterministic logical paths and no hidden writes.
+- Keep risky semantic adapters behind the spawn-worker dispatch boundary and
+  import their parser dependencies only in the guarded worker. Keep direct host
+  operations such as bounded binary extraction explicit and narrowly scoped.
+- Do not execute macros, scripts, formulas, or external links while parsing.
+- Preserve unknown bytes when a lossless source/record view is promised.
+- Raise the existing public error category with a concise safe message; do not
+  leak an absolute root in stable IDs.
+- Add resource limits at the point where expansion/allocation occurs, together
+  with a test that crosses the limit.
+
+Ruff and strict mypy policy are configured in `pyproject.toml`.
+
+## Tests
+
+Run a focused test during development, then the full suite:
+
+```console
+pytest tests/test_structured_text.py
+pytest
+ruff check .
+mypy
+```
+
+New adapters or surfaces need tests for:
+
+- normal hierarchy and pagination;
+- stable/source references and byte-exact raw reconstruction where applicable;
+- malformed and truncated input;
+- traversal/entity/archive/repetition or comparable adversarial structures;
+- configured size/count limits;
+- spawn-worker dispatch, total-deadline cleanup/replacement, stable failure
+  diagnostics, and the network guard when the adapter uses isolated semantic
+  parsing;
+- search/index behavior; and
+- platform-specific paths without requiring proprietary applications in the
+  general unit suite.
+
+Tests that require a real local Office/LibreOffice installation belong in an
+explicit machine-validation procedure, not an unconditional CI job.
+
+## Public contracts and JSON Schemas
+
+Exported Pydantic model names ending in `V1` have committed schemas under
+`src/agent_folder_workspace/schemas/`. After a deliberate contract change:
+
+```console
+python scripts/generate_json_schemas.py
+git diff -- src/agent_folder_workspace/schemas
+python scripts/generate_json_schemas.py --check
+```
+
+Review schema diffs as API changes. Additive-looking changes can still break
+strict consumers because models reject unknown fields; introduce a new
+versioned contract when compatibility cannot be preserved.
+
+## Documentation and formats
+
+When adding a format:
+
+1. map its extensions in the registry;
+2. define stable virtual paths and semantic/raw boundaries;
+3. document whether the adapter streams or materializes a bounded structure;
+4. document encryption, formula, macro, external-link, embedded-object, and
+   rendering behavior, including whether recognized embedded files mount as
+   nested workspaces or remain raw bytes; and
+5. update [docs/formats.md](docs/formats.md) without claiming structures the
+   tests do not demonstrate.
+
+Use "supported" narrowly. Raw package access is not equivalent to complete
+semantic support, and text extraction is not rendering or OCR.
+
+## Distribution gate
+
+Builds must contain package resources and legal metadata without local caches,
+compiled bytecode, tests, or maintainer scripts in the wheel. The sdist retains
+the sources needed to reproduce and review the build.
+
+```console
+python scripts/generate_json_schemas.py --check
+ruff check .
+mypy
+pytest
+python -m build --no-isolation
+python scripts/check_wheel.py dist --install-smoke
+python scripts/check_wheel.py --reproducible
+```
+
+`scripts/check_wheel.py` can build a temporary wheel when no path is supplied.
+The install smoke test force-reinstalls that wheel without dependency resolution
+into the current environment and imports it from outside the checkout; use a
+disposable virtual environment if preserving an editable install matters.
+
+Do not hand-edit wheel archives or generated RECORD files. Avoid changing
+`pyproject.toml` solely to mask a missing resource; first add a distribution test
+that demonstrates Hatchling does not include it with the current package layout.
+
+## Pull requests
+
+Keep one coherent behavior per pull request. Describe:
+
+- the user-visible outcome;
+- tests that failed before and pass after;
+- format/security/cache/platform trade-offs;
+- any intentionally unsupported case; and
+- distribution commands run.
+
+Do not mix generated build directories or unrelated formatting changes into the
+patch. Contributions are submitted under the repository's
+[Apache-2.0 license](LICENSE).
+
+## Security fixes
+
+Do not open a public pull request for an undisclosed vulnerability. Follow
+[SECURITY.md](SECURITY.md) and coordinate a private fix and disclosure first.

agent_folder_workspace-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        https://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
+
+       https://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.