translate-dir-lib 0.1.2__tar.gz

translate_dir_lib-0.1.2/.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build frontend
+        run: pip install build
+
+      - name: Build sdist and wheel
+        run: python -m build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write   # trusted publishing — no API token needed
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+

translate_dir_lib-0.1.2/.github/workflows/tests.yml

@@ -0,0 +1,28 @@
+name: Tests
+
+on:
+  push:
+    branches: ["dev"]
+  pull_request:
+    branches: ["dev", "master"]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: "pyproject.toml"
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Run tests
+        run: uv run pytest

translate_dir_lib-0.1.2/.gitignore

@@ -0,0 +1,7 @@
+**/__pycache__/
+build/
+*.egg-info/
+dist/
+uv.lock
+test-files/
+

translate_dir_lib-0.1.2/.python-version

@@ -0,0 +1 @@
+3.12

translate_dir_lib-0.1.2/CITATION.cff

@@ -0,0 +1,12 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite it using the following metadata."
+title: "sci-trans-git"
+version: "1.0.0"
+date-released: 2025-06-30
+authors:
+  - family-names: Korotenko
+    given-names: Yehor
+    orcid: https://orcid.org/0009-0002-4570-2391
+repository-code: https://github.com/DobbiKov/sci-trans-git
+license: MIT
+doi: 10.5281/zenodo.15775111

translate_dir_lib-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Contributing
+
+Before contributing, make sure to read [the profound explanation](./docs/tool-profound-explanation.md) in order to understand how the tool work and its idea.
+
+Each pull request must contain the following sections:
+
+- **Motivation** - describes why this pull request is created in the first place (can be one sentence short).
+- **Explanation** - explains what does the pull request change in the project's code base or architecture.
+
+If you want to contribute but don't know what to start with, read the ToDo section in the [README](README.md).
+
+All pull requests, ideas and suggestions are welcome!
+
+## Logging and CLI output
+
+This project standardizes diagnostics on Loguru and keeps user-facing CLI output as prints:
+
+- **Default CLI behavior**: show user-facing `print` output plus Loguru warnings/errors on stderr.
+- **Verbose mode (`--verbose` / `-v`)**: show both `print` output and all Loguru logs (including debug/trace).
+
+Conventions:
+
+- Use `print` only for user-facing CLI messages (results, progress, prompts).
+- Use `loguru.logger` for diagnostics (debug/info/warn/error, stack traces, internal state).
+- Library code should not configure Loguru; the CLI entrypoint wires log sinks and verbosity.

translate_dir_lib-0.1.2/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.

translate_dir_lib-0.1.2/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: translate-dir-lib
+Version: 0.1.2
+Summary: A library for automated directory translation
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: google-genai>=1.16.1
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: jupytext>=1.17.1
+Requires-Dist: linkify-it-py>=2.0.3
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: markdown-it-py>=3.0.0
+Requires-Dist: mdit-py-plugins>=0.4.2
+Requires-Dist: pydantic>=2.11.5
+Requires-Dist: pylatexenc>=2.10
+Requires-Dist: tree-sitter-language-pack>=0.9.0
+Requires-Dist: typer>=0.20.0
+Requires-Dist: typst-syntax>=0.1.6
+Requires-Dist: unified-model-caller==0.2.2
+Dynamic: license-file
+
+# Translate directory library
+
+A library and a CLI to manage the translation text writing projects (e.g: LaTeX,
+Markdown, Jupyter, MyST, Typst). The library is aimed to simplify and automate
+the translation process and compiling of the translated version of the documents.
+
+## Credits
+- **Nicolas M. Thiéry** - for supervising this project.
+- **LISN (Université Paris-Saclay)** - for financing the internship and
+  providing workspace.
+- **CentraleSupélec** - for financing the project.
+
+## **Important**
+
+> The library is still in an early phase of development and may have bugs and unimplemented features
+
+## Features
+
+- [x] Project creation
+- [x] Source language and the source folder to translate setting
+- [x] Target language addition
+- [x] Project files syncing (between languages)
+- [x] Translation cache
+- [x] File translation
+- [x] Translation correction
+
+The profound explanation of the logic and algorithms of the tool can be found [here](./docs/tool-profound-explanation.md)
+
+## Installation
+
+### For CLI usage
+1. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+2. Enter to the directory: `cd translate-dir-lib`
+3. Install the CLI: `uv tool install -e .`
+4. Use it: `translate-dir`
+### For in-project library usage
+
+1. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+2. Enter to your project where you want to use this library (`cd <your_project_path>`)
+3. Install the library as a dependency using `pip`: `pip install <path_to_the_library_directory>`
+4. Enjoy!
+
+### For the library development and contribution uses
+
+1. Ensure you have [uv](https://docs.astral.sh/uv/#__tabbed_1_1) tool installed
+   (visit their site for the installation guide)
+2. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+3. Enter `cd translate-dir-lib`
+4. Install dependencies `uv sync`
+5. Enjoy
+
+## Testing 
+1. Install the dependencies using `uv sync`
+2. Run tests: `uv run pytest`
+
+## Documentation
+
+- [Library API reference](./docs/main.md)
+- [CLI documentation](./docs/cli.md)
+- [Architecture and algorithms](./docs/tool-profound-explanation.md)
+- [Typst parsing and implementation](./docs/typst_parsing_analysis.md)
+
+## ToDo
+
+## 📚 Citation
+
+If you use this software in your research or writing, please cite it as follows:
+
+```bib
+@software{korotenko-sci-trans-git,
+    author = {Yehor Korotenko},
+    title = {sci-trans-git},
+    year = {2025},
+    publisher = {GitHub},
+    version = {0.2.0-alpha},
+    url = {https://github.com/DobbiKov/sci-trans-git},
+    doi = {10.5281/zenodo.15775111}
+}
+```
+
+## Contributing
+
+The suggestions and pull requests are welcome. Visit the issues pages as well
+as the project's [main page](https://github.com/DobbiKov/sci-trans-git) and the
+[shared document](https://codimd.math.cnrs.fr/sUW9PQ1tTLWcR98UjLHLpw) in order
+to know the current direction and plans of the project.

translate_dir_lib-0.1.2/README.md

@@ -0,0 +1,86 @@
+# Translate directory library
+
+A library and a CLI to manage the translation text writing projects (e.g: LaTeX,
+Markdown, Jupyter, MyST, Typst). The library is aimed to simplify and automate
+the translation process and compiling of the translated version of the documents.
+
+## Credits
+- **Nicolas M. Thiéry** - for supervising this project.
+- **LISN (Université Paris-Saclay)** - for financing the internship and
+  providing workspace.
+- **CentraleSupélec** - for financing the project.
+
+## **Important**
+
+> The library is still in an early phase of development and may have bugs and unimplemented features
+
+## Features
+
+- [x] Project creation
+- [x] Source language and the source folder to translate setting
+- [x] Target language addition
+- [x] Project files syncing (between languages)
+- [x] Translation cache
+- [x] File translation
+- [x] Translation correction
+
+The profound explanation of the logic and algorithms of the tool can be found [here](./docs/tool-profound-explanation.md)
+
+## Installation
+
+### For CLI usage
+1. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+2. Enter to the directory: `cd translate-dir-lib`
+3. Install the CLI: `uv tool install -e .`
+4. Use it: `translate-dir`
+### For in-project library usage
+
+1. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+2. Enter to your project where you want to use this library (`cd <your_project_path>`)
+3. Install the library as a dependency using `pip`: `pip install <path_to_the_library_directory>`
+4. Enjoy!
+
+### For the library development and contribution uses
+
+1. Ensure you have [uv](https://docs.astral.sh/uv/#__tabbed_1_1) tool installed
+   (visit their site for the installation guide)
+2. Clone the repo: `git clone https://github.com/DobbiKov/translate-dir-lib`
+3. Enter `cd translate-dir-lib`
+4. Install dependencies `uv sync`
+5. Enjoy
+
+## Testing 
+1. Install the dependencies using `uv sync`
+2. Run tests: `uv run pytest`
+
+## Documentation
+
+- [Library API reference](./docs/main.md)
+- [CLI documentation](./docs/cli.md)
+- [Architecture and algorithms](./docs/tool-profound-explanation.md)
+- [Typst parsing and implementation](./docs/typst_parsing_analysis.md)
+
+## ToDo
+
+## 📚 Citation
+
+If you use this software in your research or writing, please cite it as follows:
+
+```bib
+@software{korotenko-sci-trans-git,
+    author = {Yehor Korotenko},
+    title = {sci-trans-git},
+    year = {2025},
+    publisher = {GitHub},
+    version = {0.2.0-alpha},
+    url = {https://github.com/DobbiKov/sci-trans-git},
+    doi = {10.5281/zenodo.15775111}
+}
+```
+
+## Contributing
+
+The suggestions and pull requests are welcome. Visit the issues pages as well
+as the project's [main page](https://github.com/DobbiKov/sci-trans-git) and the
+[shared document](https://codimd.math.cnrs.fr/sUW9PQ1tTLWcR98UjLHLpw) in order
+to know the current direction and plans of the project.

translate_dir_lib-0.1.2/cache.md

@@ -0,0 +1,81 @@
+# Cache Clear Technical Report
+
+## Overview
+This change adds cache clear behaviors:
+- `translate-dir cache clear --missing-chunks` cleans the cache by removing or fixing correspondence entries that point to missing chunk files. It also removes orphaned source chunks that have no correspondence rows.
+- `translate-dir cache clear --all --lang <language>` and/or `--file <path>` deletes cached data scoped to a specific language and/or file.
+- `translate-dir cache clear --all --keyword <string>` deletes cached chunks whose contents include the keyword, with optional `--lang`/`--file` scoping.
+
+## Files and Components
+- `src/trans_lib/translation_cache/cache_cleaner.py`
+  - Cleanup implementations.
+  - Exposes `clear_missing_chunks(root_path, source_lang)` and `clear_all(root_path, lang, relative_path)`.
+- `src/trans_lib/project_runtime.py`
+  - Adds cache clear wrappers with error handling.
+- `src/trans_lib/project_manager.py`
+  - Adds convenience methods for cache clear actions.
+- `src/cli.py`
+  - Adds `translate-dir cache clear --missing-chunks` and `--all` CLI entry points.
+- `src/trans_lib/errors.py`
+  - Adds `TranslationCacheClearError`.
+- `tests/test_cache_clear.py`
+  - New coverage for row removal, field clearing, and orphan source deletion.
+
+## Cache Layout (used by cleanup)
+The cleanup logic directly scans the on-disk cache and ignores `path_checksums.csv`.
+- Cache root: `<project>/.translate_dir/translate_cache`
+- Chunk files are stored by language and path checksum:
+  - `<lang>/<path_hash>/<chunk_checksum>`
+
+## Cleanup Algorithm (missing-chunks)
+Inputs:
+- Source language from project config.
+- Correspondence CSV (`correspondence_cache.csv`) if present.
+- On-disk chunk files.
+
+Steps:
+1. Load cache root. If it does not exist, exit with zero changes.
+2. Enumerate all source language chunk files (including any that are stored directly under `<lang>/`).
+3. Load correspondence rows:
+   - If CSV does not exist: treat all source chunks as orphaned and delete them.
+4. For each row:
+   - Resolve `path_hash` and source checksum.
+   - If source checksum is missing or its chunk file is missing: remove the row.
+   - Otherwise, validate all target language checksum files:
+     - If at least one target chunk file exists, clear only missing target fields.
+     - If no target chunk files exist, remove the row.
+5. Write a new correspondence CSV if any row was removed or fields were cleared.
+6. Remove any source chunk files that are not referenced by a kept correspondence row.
+
+## Behavior Summary
+- Rows with missing source files are removed.
+- Rows with no existing target chunk files are removed.
+- Rows with some missing targets are kept and the missing checksum fields are cleared.
+- Orphaned source chunks (no correspondence row) are deleted.
+- Target chunk files are deleted when they are not referenced by any remaining correspondence row.
+- Keyword deletes only the matching chunk files and clears corresponding fields; rows are removed only when all language fields are empty.
+
+## CLI Usage
+```
+translate-dir cache clear --missing-chunks
+```
+```
+translate-dir cache clear --all --lang English
+translate-dir cache clear --all --file src_en/doc.md
+translate-dir cache clear --all --lang French --file src_en/doc.md
+translate-dir cache clear --all
+translate-dir cache clear --all --keyword glossary
+translate-dir cache clear --all --file src_en/doc.md --keyword glossary
+```
+The command requires at least one action flag. `--lang` and `--file` only work with `--all`. `--all` without scopes clears all cache and correspondence rows. It reports:
+- removed rows
+- cleared fields
+- removed chunk files
+
+## Tests Added
+- `test_clear_missing_chunks_removes_row_and_source`
+- `test_clear_missing_chunks_clears_missing_target_fields`
+- `test_clear_missing_chunks_removes_row_when_source_missing`
+- `test_clear_missing_chunks_removes_orphan_source_chunks`
+
+These tests validate row removal, field clearing, orphan removal, and the non-deletion of target chunk files.