tinbox 0.1.0__tar.gz

tinbox-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# PyPI configuration file
+.pypirc
+
+# Project-specific files
+design/

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

tinbox-0.1.0/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: tinbox
+Version: 0.1.0
+Summary: A CLI translation tool using LLMs for document translation
+Author-email: strickvl <your.email@example.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,docx,llm,pdf,translation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.9
+Requires-Dist: asyncio>=3.4.3
+Requires-Dist: litellm>=1.30.0
+Requires-Dist: pydantic>=2.6.0
+Requires-Dist: pypdf>=5.3.0
+Requires-Dist: python-docx>=1.1.2
+Requires-Dist: rich>=13.7.0
+Requires-Dist: structlog>=24.1.0
+Requires-Dist: tenacity>=8.2.3
+Requires-Dist: typer>=0.9.0
+Provides-Extra: dev
+Requires-Dist: black>=24.2.0; extra == 'dev'
+Requires-Dist: isort>=5.13.2; extra == 'dev'
+Requires-Dist: mypy>=1.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.5; extra == 'dev'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.2.1; extra == 'dev'
+Provides-Extra: docx
+Requires-Dist: python-docx>=1.1.0; extra == 'docx'
+Provides-Extra: pdf
+Requires-Dist: pdf2image>=1.17.0; extra == 'pdf'
+Description-Content-Type: text/markdown
+
+# 🔄 Tinbox: Your Ultimate CLI Translation Tool
+
+**Tinbox** is a robust command-line tool designed to tackle the challenges of translating large documents, especially PDFs, using Large Language Models (LLMs). Unlike other tools, Tinbox excels in handling extensive document sizes and navigates around model limitations related to size and copyright issues, ensuring seamless and efficient translations.
+
+**Why Choose Tinbox?**
+- **Handles Large Documents**: Efficiently processes large PDFs and other document types.
+- **Overcomes Model Limitations**: Bypasses common model refusals due to size or copyright concerns.
+- **No OCR Needed**: Directly translates PDFs using advanced multimodal models.
+- **Smart Algorithms**: Achieve optimal translation results with our intelligent algorithms.
+- **Local and Cloud Support**: Use models locally or in the cloud, depending on your preference.
+
+**Quick Start Example:**
+```bash
+tinbox --to es document.pdf
+```
+
+## 🎯 The Problems Tinbox Solves
+
+1. **PDF Translation Challenges**
+   - Most tools require OCR, leading to formatting loss and errors
+   - Tinbox uses multimodal models to directly understand PDFs as images
+
+2. **Large Document Limitations**
+   - Traditional tools often fail with large documents
+   - Models frequently refuse or timeout on big files
+   - Tinbox smartly splits and processes documents while maintaining context
+
+3. **Model Refusal Issues**
+   - Many models refuse translation tasks due to:
+     - Copyright concerns
+     - Document size limitations
+     - Rate limiting
+   - Tinbox's algorithms work around these limitations intelligently
+
+4. **Quality and Consistency**
+   - Smart algorithms ensure consistent translations across document sections
+   - Maintains context between pages and segments
+   - Repairs potential inconsistencies at section boundaries
+
+![Tinbox Workflow](link_to_diagram.png)
+
+🔍 **Key Highlights:**
+- Translate PDFs without OCR using advanced AI models
+- Handle documents of any size with smart splitting algorithms
+- Work around common model limitations and refusals
+- Track costs and performance with built-in benchmarking
+
+## ✨ Features
+
+### 📄 Smart Document Handling
+- **PDFs**: Processed directly as images - no OCR needed!
+- **Word (docx)**: Preserves formatting while translating
+- **Text files**: Efficient processing for large files
+
+### 🧠 Intelligent Translation
+- **Smart Algorithms**:
+  - Page-by-Page with Seam Repair (default for PDF)
+  - Sliding Window for long text documents
+  - Automatic context preservation between sections
+
+### 🤖 Flexible Model Support
+- Use powerful cloud models (GPT-4V, Claude 3.5 Sonnet)
+- Run translations locally with Ollama
+- Mix and match models for different tasks
+
+### 🌐 Language Support
+- Flexible source/target language specification using ISO 639-1 codes
+- Common language aliases (e.g., 'en', 'zh', 'es')
+
+6. 📊 **Benchmarking**  
+   - Track overall translation time and token usage/cost
+   - Compare algorithms or model providers side-by-side
+
+## 🚀 Getting Started
+
+### Quick Install
+
+```bash
+# Install base package
+pip install tinbox
+
+# For PDF support (recommended)
+pip install tinbox[pdf]
+
+# For Word document support
+pip install tinbox[docx]
+
+# Install everything
+pip install tinbox[all]
+```
+
+### Basic Usage
+
+1. **Translate a PDF to Spanish**
+   ```bash
+   tinbox --to es document.pdf
+   ```
+
+2. **Translate a Word document from Chinese to English**
+   ```bash
+   tinbox --from zh --to en document.docx
+   ```
+
+3. **Handle a large text file with custom settings**
+   ```bash
+   tinbox --to fr --algorithm sliding-window large_document.txt
+   ```
+
+### 💡 Tips for Best Results
+
+1. **For Large Documents**
+   - Use the sliding window algorithm: `--algorithm sliding-window`
+   - Adjust window size if needed: `--window-size 3000`
+
+2. **For PDFs**
+   - The default page-by-page algorithm works best
+   - No OCR needed - just point to your PDF!
+
+3. **For Best Performance**
+   - Use local models via Ollama for faster processing
+   - Cloud models (GPT-4V, Claude) for highest quality
+
+## 📖 Detailed Documentation
+
+### Command-Line Options
+
+#### Core Options
+| Option              | Description                                           | Example                    |
+|--------------------|-------------------------------------------------------|----------------------------|
+| `--from, -f`       | Source language (auto-detect if not specified)        | `--from zh`               |
+| `--to, -t`         | Target language (default: English)                    | `--to es`                 |
+| `--model`          | Model to use for translation                          | `--model gpt-4v`          |
+| `--output, -o`     | Output file (default: print to console)              | `--output translated.txt`  |
+
+#### Algorithm Options
+| Option              | Description                                           | Default                    |
+|--------------------|-------------------------------------------------------|----------------------------|
+| `--algorithm, -a`  | Translation algorithm (`page` or `sliding-window`)    | `page` for PDF            |
+| `--window-size`    | Size of translation window                            | 2000 tokens               |
+| `--overlap-size`   | Overlap between windows                               | 200 tokens                |
+
+#### Output Format Options
+| Option              | Description                                           | Example Output             |
+|--------------------|-------------------------------------------------------|----------------------------|
+| `--format, -F`     | Output format (text, json, markdown)                  | See examples below         |
+| `--benchmark, -b`  | Include performance metrics                           | Translation time, costs    |
+
+### Supported Languages
+
+Common language codes (ISO 639-1):
+
+| Code | Language    | Also Accepts |
+|------|-------------|--------------|
+| en   | English     | eng          |
+| es   | Spanish     | spa          |
+| zh   | Chinese     | chi, cmn     |
+| fr   | French      | fra          |
+| de   | German      | deu, ger     |
+| ja   | Japanese    | jpn          |
+| ko   | Korean      | kor          |
+| ru   | Russian     | rus          |
+| ar   | Arabic      | ara          |
+| hi   | Hindi       | hin          |
+
+### Output Format Examples
+
+#### 1. Plain Text (Default)
+```bash
+tinbox translate document.pdf --to es
+# Output: Translated text...
+```
+
+#### 2. JSON Output
+```bash
+tinbox translate document.pdf --to es --format json
+```
+
+Example response:
+```json
+{
+  "metadata": {
+    "source_lang": "en",
+    "target_lang": "es",
+    "model": "claude-3-sonnet",
+    "algorithm": "page"
+  },
+  "result": {
+    "text": "Translated text...",
+    "tokens_used": 1500,
+    "cost": 0.045,
+    "time_taken": 12.5
+  }
+}
+```
+
+#### 3. Markdown Report
+```bash
+tinbox translate document.pdf --to es --format markdown
+```
+
+### Advanced Usage
+
+1. **Handling Very Large Documents**
+   ```bash
+   tinbox --to es --algorithm sliding-window \
+          --window-size 3000 --overlap-size 300 \
+          large_document.pdf
+   ```
+
+2. **Using Local Models**
+   ```bash
+   tinbox --to fr --model ollama:mistral-small document.txt
+   ```
+
+3. **Benchmarking Different Models**
+   ```bash
+   tinbox --to de --benchmark --model gpt-4v document.pdf
+   ```
+
+## 🛠 Project Structure
+
+```
+tinbox/
+├── src/
+│   └── tinbox/
+│       ├── cli.py                 # Command-line interface
+│       ├── core/                  # Core functionality
+│       │   ├── cost.py           # Cost tracking
+│       │   ├── processor/        # Document processors
+│       │   └── translation/      # Translation algorithms
+│       └── utils/                # Utilities
+└── tests/                        # Test suite
+```
+
+## 🔜 Future Plans
+
+1. **Enhanced Output Formats**
+   - PDF output with original formatting
+   - Word document export
+   - HTML with parallel text
+
+2. **Advanced Features**
+   - AI-powered section detection
+   - Custom terminology support
+   - Interactive translation review
+   - Domain-specific model fine-tuning
+
+3. **Performance Improvements**
+   - Parallel processing
+   - Better caching
+   - Reduced API costs