mdtomd 0.1.0__tar.gz

mdtomd-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include README.md
+include pyproject.toml
+graft mdtomd
+graft scripts
+prune tests
+prune vscode-extension
+prune examples
+exclude config.yaml
+exclude env.example
+exclude llm-prices.md

mdtomd-0.1.0/PKG-INFO

@@ -0,0 +1,137 @@
+Metadata-Version: 2.4
+Name: mdtomd
+Version: 0.1.0
+Summary: Markdown/MDX translation CLI
+Keywords: markdown,mdx,translation,llm
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Text Processing :: Markup
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: openai<2,>=1.75
+Requires-Dist: tiktoken<1,>=0.8
+
+# mdtomd
+
+一个给自己用的 Markdown/MDX 翻译工具。
+
+默认会读取当前目录的 `config.yaml`，支持：
+
+- 单文件翻译
+- 目录批量翻译
+- `.md` / `.markdown` / `.mdx`
+- 翻译前 token 估算
+- 翻译后显示输入 / 输出 token
+
+**安装**
+
+发布版安装：
+
+```bash
+python3 -m pip install mdtomd
+```
+
+本地开发安装：
+
+```bash
+python3 -m pip install -e .
+```
+
+**配置**
+
+直接改 `config.yaml` 即可。
+
+常见方式：
+
+1. 在 `providers.<provider>` 里写 `model/base_url/api_key/max_tokens`
+2. 在 `llm.provider` 里选默认 provider
+3. `translator.chunk_size` 留空时，会默认跟当前模型的 `max_tokens` 一致
+4. 临时覆盖时再用命令行参数或环境变量
+
+如果不想把 key 写进配置，可以用环境变量，例如：
+
+```bash
+export DEEPSEEK_API_KEY="your-key"
+```
+
+**用法**
+
+快捷命令，先 estimate 再 translate：
+
+```bash
+mdtomd examples/doc1.md
+mdtomd examples
+```
+
+单文件翻译：
+
+```bash
+mdtomd translate -i examples/doc1.md
+```
+
+目录翻译：
+
+```bash
+mdtomd translate -i examples
+```
+
+目录输入会自动递归处理，并默认把结果写回原目录，生成 `*_zh.md` / `*_zh.mdx`。
+
+如果想输出到别的目录：
+
+```bash
+mdtomd translate -i examples --output-dir out
+```
+
+先看 token：
+
+```bash
+mdtomd estimate -i examples/doc1.md
+mdtomd estimate -i examples
+```
+
+查看 provider 和模型：
+
+```bash
+mdtomd providers
+mdtomd models
+```
+
+**输出说明**
+
+单文件翻译完成后会额外打印：
+
+- `原文 tokens`
+- `请求输入 tokens`
+- `回复输出 tokens`
+
+其中：
+
+- `请求输入 tokens` 是按当前 prompt 和分块策略统计的输入 token
+- `回复输出 tokens` 是模型接口实际返回的 completion token
+
+**测试**
+
+```bash
+python3 -m unittest discover -s tests -v
+```
+
+**CLI 发布**
+
+构建并检查产物：
+
+```bash
+./scripts/build_cli.sh
+```
+
+上传到 PyPI：
+
+```bash
+export TWINE_PASSWORD="pypi-***"
+./scripts/publish_cli.sh
+```

mdtomd-0.1.0/README.md

@@ -0,0 +1,119 @@
+# mdtomd
+
+一个给自己用的 Markdown/MDX 翻译工具。
+
+默认会读取当前目录的 `config.yaml`，支持：
+
+- 单文件翻译
+- 目录批量翻译
+- `.md` / `.markdown` / `.mdx`
+- 翻译前 token 估算
+- 翻译后显示输入 / 输出 token
+
+**安装**
+
+发布版安装：
+
+```bash
+python3 -m pip install mdtomd
+```
+
+本地开发安装：
+
+```bash
+python3 -m pip install -e .
+```
+
+**配置**
+
+直接改 `config.yaml` 即可。
+
+常见方式：
+
+1. 在 `providers.<provider>` 里写 `model/base_url/api_key/max_tokens`
+2. 在 `llm.provider` 里选默认 provider
+3. `translator.chunk_size` 留空时，会默认跟当前模型的 `max_tokens` 一致
+4. 临时覆盖时再用命令行参数或环境变量
+
+如果不想把 key 写进配置，可以用环境变量，例如：
+
+```bash
+export DEEPSEEK_API_KEY="your-key"
+```
+
+**用法**
+
+快捷命令，先 estimate 再 translate：
+
+```bash
+mdtomd examples/doc1.md
+mdtomd examples
+```
+
+单文件翻译：
+
+```bash
+mdtomd translate -i examples/doc1.md
+```
+
+目录翻译：
+
+```bash
+mdtomd translate -i examples
+```
+
+目录输入会自动递归处理，并默认把结果写回原目录，生成 `*_zh.md` / `*_zh.mdx`。
+
+如果想输出到别的目录：
+
+```bash
+mdtomd translate -i examples --output-dir out
+```
+
+先看 token：
+
+```bash
+mdtomd estimate -i examples/doc1.md
+mdtomd estimate -i examples
+```
+
+查看 provider 和模型：
+
+```bash
+mdtomd providers
+mdtomd models
+```
+
+**输出说明**
+
+单文件翻译完成后会额外打印：
+
+- `原文 tokens`
+- `请求输入 tokens`
+- `回复输出 tokens`
+
+其中：
+
+- `请求输入 tokens` 是按当前 prompt 和分块策略统计的输入 token
+- `回复输出 tokens` 是模型接口实际返回的 completion token
+
+**测试**
+
+```bash
+python3 -m unittest discover -s tests -v
+```
+
+**CLI 发布**
+
+构建并检查产物：
+
+```bash
+./scripts/build_cli.sh
+```
+
+上传到 PyPI：
+
+```bash
+export TWINE_PASSWORD="pypi-***"
+./scripts/publish_cli.sh
+```

mdtomd-0.1.0/mdtomd/__init__.py

@@ -0,0 +1,36 @@
+from .config import (
+    AppConfig,
+    DefaultsConfig,
+    DisplayConfig,
+    FeaturedModelConfig,
+    LLMConfig,
+    ProviderOverrideConfig,
+    TranslatorConfig,
+    load_config,
+)
+from .llm import create_llm_client, list_supported_providers, resolve_runtime_config
+from .pricing import ModelPrice, estimate_cost, lookup_model_price
+from .translator import BatchTokenEstimate, FileTokenEstimate, MarkdownTokenEstimate, MarkdownTranslator, TranslateFilesOptions
+
+__all__ = [
+    "AppConfig",
+    "DefaultsConfig",
+    "DisplayConfig",
+    "FeaturedModelConfig",
+    "BatchTokenEstimate",
+    "FileTokenEstimate",
+    "LLMConfig",
+    "ModelPrice",
+    "MarkdownTokenEstimate",
+    "MarkdownTranslator",
+    "ProviderOverrideConfig",
+    "TranslateFilesOptions",
+    "TranslatorConfig",
+    "create_llm_client",
+    "estimate_cost",
+    "list_supported_providers",
+    "load_config",
+    "lookup_model_price",
+    "resolve_runtime_config",
+]
+

mdtomd-0.1.0/mdtomd/__main__.py

@@ -0,0 +1,5 @@
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())