tryworks 0.1.0__tar.gz

tryworks-0.1.0/.gitignore

@@ -0,0 +1,8 @@
+.venv/
+__pycache__/
+*.pyc
+*.egg-info/
+dist/
+build/
+.pytest_cache/
+compat/out/

tryworks-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.

tryworks-0.1.0/NOTICE

@@ -0,0 +1,17 @@
+tryworks
+Copyright 2026 The tryworks contributors
+
+This product is an independent implementation of the public Python API of
+"unstructured" (https://github.com/Unstructured-IO/unstructured),
+Copyright 2022 Unstructured Technologies, Inc., licensed under the
+Apache License, Version 2.0.
+
+The element types, metadata field names, function signatures and chunking
+semantics of tryworks are modeled on that API so tryworks can serve as a
+drop-in replacement for its document-partitioning call path. tryworks does
+not contain source code copied from unstructured, and its test corpus is
+generated by tryworks' own scripts rather than taken from unstructured's
+example documents.
+
+"Unstructured" is a name of Unstructured Technologies, Inc. tryworks is not
+affiliated with, endorsed by, or sponsored by Unstructured Technologies, Inc.

tryworks-0.1.0/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.5
+Name: tryworks
+Version: 0.1.0
+Summary: Partition documents into LLM-ready elements. The call path of unstructured, with zero required dependencies.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: chunking,document parsing,docx,llm,pdf,rag,unstructured
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: openpyxl>=3.1; extra == 'dev'
+Requires-Dist: pypdfium2>=4.30; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: python-docx>=1.1; extra == 'dev'
+Requires-Dist: python-pptx>=1.0; extra == 'dev'
+Provides-Extra: pdf
+Requires-Dist: pypdfium2>=4.30; extra == 'pdf'
+Description-Content-Type: text/markdown
+
+# tryworks
+
+[![CI](https://github.com/ezzcodeezzlife/tryworks/actions/workflows/ci.yml/badge.svg)](https://github.com/ezzcodeezzlife/tryworks/actions/workflows/ci.yml)
+![Python 3.10–3.14](https://img.shields.io/badge/python-3.10%E2%80%933.14-3776ab)
+![Dependencies: 0](https://img.shields.io/badge/dependencies-0-2ea44f)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+**Turn PDFs, Word, PowerPoint, Excel, HTML, Markdown, email and text into LLM-ready elements, with
+zero required dependencies.**
+
+tryworks implements the document-partitioning call path of
+[unstructured](https://github.com/Unstructured-IO/unstructured): the same `partition()` function,
+the same element types and metadata, the same chunking, the same JSON. It leaves out what most
+pipelines never call, namely OCR, layout models and ingest connectors, and the 2 GB of
+dependencies they bring.
+
+```python
+from tryworks.partition.auto import partition
+from tryworks.chunking.title import chunk_by_title
+
+elements = partition("quarterly-report.docx")
+chunks = chunk_by_title(elements, max_characters=1000)
+
+for chunk in chunks:
+    print(chunk.metadata.page_number, chunk.text[:80])
+```
+
+> The name: tryworks were the brick furnaces on whaling ships that rendered raw blubber into oil.
+
+## Why
+
+Measured on Linux x86-64 with Python 3.12, reading the same document types:
+
+|  | `unstructured[docx,pptx,xlsx,md,csv,pdf]` | `tryworks[pdf]` |
+|---|---:|---:|
+| Packages installed | 149 | **2** |
+| Download size | 3,257 MB | **3.6 MB** |
+| Installed size (unstructured with CPU-only torch) | 2.0 GB | **9 MB** |
+| Importing `partition` plus the PDF and DOCX partitioners | 4.4–6.2 s | **0.15–0.39 s** |
+| Partitioning the 9-document test corpus, first call included | 7.2 s | **0.59 s** |
+| Security advisories ever published for the installed packages | 701 | **0** |
+| Lines of library code | 34,171 | 5,449 |
+
+Base `tryworks` without the PDF extra is a single 80 KB wheel with no dependencies.
+
+In practice that means:
+
+- **It fits in AWS Lambda.** The zip deployment limit is 250 MB unpacked, and it cannot be raised.
+- **Cold starts are fast**, and since August 2025 AWS bills the Lambda init phase.
+- **Security review is short.** Two packages to approve, pin and scan, where unstructured needs
+  149. Air-gapped and regulated environments review each dependency individually.
+- **The supply-chain surface is small.** Most advisories in a large tree come from its transitive
+  dependencies, not from the library you asked for.
+
+Numbers come from `scripts/measure.py` (exact resolution with `uv pip compile`, advisory counts
+from OSV.dev) and from real installs; see [Reproducing the numbers](#reproducing-the-numbers).
+Neither tree had an open advisory against the versions resolved when this was measured; the
+701 are historical, which is what a scanner and a triage process work through over time.
+
+## Install
+
+```bash
+pip install "tryworks @ git+https://github.com/ezzcodeezzlife/tryworks"
+pip install "tryworks[pdf] @ git+https://github.com/ezzcodeezzlife/tryworks"   # PDF support
+```
+
+Python 3.10 or newer. PDF support adds [pypdfium2](https://github.com/pypdfium2-team/pypdfium2),
+bindings to PDFium, the PDF engine used in Chrome. Everything else uses the standard library.
+
+## Use
+
+### Partition
+
+```python
+from tryworks.partition.auto import partition
+
+elements = partition("report.pdf")                      # type from extension or content
+elements = partition(file=open("memo.docx", "rb"))      # file objects work too
+elements = partition(url="https://example.com/post")    # http(s) URLs
+
+for el in elements:
+    print(el.category, el.metadata.page_number, el.text)
+# Title 1 Quarterly Operations Memo
+# NarrativeText 1 Revenue grew eleven percent year over year, ...
+# ListItem 1 Expand the Rotterdam warehouse
+# Table 1 Warehouse totals Units Rotterdam KR-1001 1200 ...
+```
+
+Each format also has its own function with unstructured's signature: `partition_pdf`,
+`partition_docx`, `partition_pptx`, `partition_xlsx`, `partition_html`, `partition_md`,
+`partition_text`, `partition_csv`, `partition_tsv`, `partition_email`, `partition_json`.
+
+### Chunk
+
+```python
+from tryworks.chunking.title import chunk_by_title
+from tryworks.chunking.basic import chunk_elements
+
+chunks = chunk_by_title(elements, max_characters=1000, overlap=100)
+chunks = partition("report.pdf", chunking_strategy="by_title", max_characters=1000)
+```
+
+Sections start at each Title, small sections are combined, long text is split at newlines or
+spaces, and tables get chunks of their own. Tables too large for one chunk are split by row
+into `TableChunk` elements that keep valid HTML in `metadata.text_as_html`.
+
+### Serialize
+
+```python
+from tryworks.staging.base import elements_to_json, elements_from_json, elements_to_md
+
+json_text = elements_to_json(elements)         # same JSON as unstructured, readable by it
+elements = elements_from_json(text=json_text)
+markdown = elements_to_md(elements)
+```
+
+### Command line
+
+```bash
+tryworks report.pdf                                   # JSON
+tryworks memo.docx --format markdown
+tryworks https://example.com/post --format text --chunking-strategy by_title --max-characters 800
+```
+
+## Moving from unstructured
+
+Change the package name in your imports:
+
+```diff
+- from unstructured.partition.auto import partition
+- from unstructured.chunking.title import chunk_by_title
++ from tryworks.partition.auto import partition
++ from tryworks.chunking.title import chunk_by_title
+```
+
+For code you can't edit, such as a third-party library that imports `unstructured` itself, register
+tryworks under the `unstructured` import names before that code is imported:
+
+```python
+import tryworks
+tryworks.alias_as_unstructured()
+```
+
+This only affects imports in the current process. It installs nothing named `unstructured`.
+
+## Formats
+
+| Format | Extensions | Implementation | What you get |
+|---|---|---|---|
+| PDF | `.pdf` | PDFium via `pypdfium2` | Text blocks in reading order (multi-column aware), titles, lists, headers and footers, coordinates, page numbers |
+| Word | `.docx` | `zipfile` + `ElementTree` | Style-based titles and lists, tables with merged cells, section headers and footers, links, bold/italic, page breaks |
+| PowerPoint | `.pptx` | `zipfile` + `ElementTree` | One page per slide, titles, bullets with levels, tables, speaker notes |
+| Excel | `.xlsx` | `zipfile` + `ElementTree` | Each sheet split into sub-tables, captions as text, dates and numbers formatted |
+| HTML | `.html`, `.htm` | `html.parser` | Headings, paragraphs, nested lists, tables, code, images, links, emphasis; navigation and forms dropped |
+| Markdown | `.md` | Built-in renderer | Same elements as HTML |
+| Text | `.txt` | Standard library | Paragraphs classified as titles, prose, list items, emails, addresses |
+| CSV, TSV | `.csv`, `.tsv` | `csv` | One table, delimiter detected |
+| Email | `.eml` | `email` | Body with sender, recipients, subject and date; attachments partitioned |
+| Elements | `.json` | `json` | Elements saved by `elements_to_json`, from either library |
+
+## Compatibility with unstructured
+
+A generated corpus with one realistic document per format is partitioned by both libraries and
+compared element by element ([report](compat/REPORT.md), [script](scripts/compat.py)). A
+[workflow](.github/workflows/compat.yml) repeats the comparison weekly against the latest
+unstructured release.
+
+Against unstructured 0.27.5:
+
+- **97%** of upstream elements have a tryworks element with identical text,
+- **97%** of those have the same element type,
+- **94%** have the same element id (ids hash filename, text, page and position, so this also
+  checks ordering),
+- `parent_id`, `filetype`, `page_number`, `page_name`, `link_urls`, `emphasized_text_contents`,
+  `header_footer_type`, `sent_from` and `subject` agree on every aligned element.
+
+Every remaining difference in the report is one of the deliberate differences listed below.
+
+### Deliberate differences
+
+| Where | unstructured | tryworks | Why |
+|---|---|---|---|
+| Markdown lists | Python-Markdown joins a numbered list with the bullet list after it and turns items next to blank lines into paragraphs | Separate lists, every item a `ListItem` | CommonMark behavior; bullets stay bullets |
+| PDF bullets | Consecutive bullet lines can merge into one `ListItem` | One `ListItem` per bullet | Each bullet is its own item |
+| PDF columns | Text of a right-hand column can come after the page footer | Left column, right column, then footer | Reading order |
+| PDF coordinates | pdfminer glyph boxes | PDFium glyph boxes | Within about 1 pt |
+| DOCX merged cells | 0.27.5 repeats the text in every merged cell | `colspan` / `rowspan` | Matches unstructured's main branch |
+| Language | `langdetect` | Script detection plus stopword profiles for 18 languages | No model dependency; results can differ on tables and fragments |
+
+### Not included
+
+- **OCR and layout models.** `strategy="hi_res"` and `"ocr_only"` raise `NotImplementedError`, and
+  scanned PDFs without embedded text produce a warning and no elements. Use unstructured or an OCR
+  service for those.
+- **Formats:** images, audio, `.doc`, `.ppt`, `.xls`, `.msg`, `.rtf`, `.odt`, `.epub`, `.rst`,
+  `.org`, `.xml`. Unsupported files raise `UnsupportedFileFormatError`, with a conversion hint.
+- **PDF table structure and image extraction.** PDF tables come out as text blocks.
+- **Pictures in DOCX and PPTX** are not emitted as `Image` elements.
+- **Token-based chunking** (`max_tokens`) raises `NotImplementedError`; use `max_characters`.
+- Ingest connectors, the hosted API client, and staging bricks for labeling tools.
+
+Text classification uses the same rules as unstructured, but detects verbs with a compact
+lexicon instead of NLTK. On borderline text such as short fragments, a paragraph can come out as
+`UncategorizedText` where unstructured says `NarrativeText`, or the reverse.
+
+## Untrusted documents
+
+Documents are parsed defensively: zip-bomb checks on Office files, rejection of XML entity
+declarations, and caps on spreadsheet cells, PDF pages, HTML nesting and chunk payloads, all
+adjustable through environment variables. Only http(s) URLs are fetched. See
+[SECURITY.md](SECURITY.md).
+
+## Reproducing the numbers
+
+```bash
+# install size, packages and advisories (needs uv)
+python scripts/measure.py "unstructured[docx,pptx,xlsx,md,csv,pdf]" "tryworks[pdf] @ ."
+
+# element-by-element comparison
+python tests/corpus.py compat/out/corpus
+python scripts/compat.py dump tryworks compat/out/corpus compat/out/tryworks.json
+python scripts/compat.py dump unstructured compat/out/corpus compat/out/upstream.json   # in an env with unstructured
+python scripts/compat.py compare compat/out/upstream.json compat/out/tryworks.json --markdown compat/REPORT.md
+```
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+python -m pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). The one hard rule: the base install stays
+dependency-free.
+
+## How this was built
+
+tryworks was written with [Claude Code](https://claude.com/claude-code) under human direction. It
+is an independent implementation of unstructured's public API; no unstructured source code was
+copied. Confidence in it comes from things you can check yourself: the test suite, which runs on
+Linux, macOS and Windows, and the differential comparison against unstructured above.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE) and [NOTICE](NOTICE). tryworks is not affiliated with or
+endorsed by Unstructured Technologies, Inc.