From f68dd794b8235204e2543426fb13d5570fc6c172 Mon Sep 17 00:00:00 2001 From: blue Date: Thu, 4 Jul 2024 11:09:53 +0800 Subject: [PATCH] fix: setup requirements --- README.md | 2 +- README_zh-CN.md | 23 +++++++++++++++++++---- setup.py | 2 +- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4369c5f..b16fbd3 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ ### Install -Prerequisites: python3.10+ +Prerequisites: python3.10 Install Dependencies diff --git a/README_zh-CN.md b/README_zh-CN.md index 4a9ffb4..af8b376 100644 --- a/README_zh-CN.md +++ b/README_zh-CN.md @@ -5,6 +5,10 @@ [![issue resolution](https://img.shields.io/github/issues-closed-raw/InternLM/magic-doc)](https://github.com/InternLM/magic-doc/issues) [![open issues](https://img.shields.io/github/issues-raw/InternLM/magic-doc)](https://github.com/InternLM/magic-doc/issues) +

+ 👋 加入我们 Discord微信社区 +

+ [English](README.md) | [简体中文](README_zh-CN.md) @@ -15,7 +19,7 @@ ### 安装 -前置依赖: python3.10 + +前置依赖: python3.10 安装依赖 @@ -44,7 +48,7 @@ pip install fairy-doc[gpu] # 安装 gpu 版本 ## 简介 -Magic-Doc 是一个轻量级、开源的用于将多种格式的文档(PPT/PPTX/DOC/DOCX/PDF) 转化为 markdown 格式的工具。支持转换本地文档或者位于 AWS S3 上的文件 +Magic-Doc 是一个轻量级、开源的用于将多种格式的文档(PPT/PPTX/DOC/DOCX/PDF)转化为 markdown 格式的工具。支持转换本地文档或者位于 AWS S3 上的文件 ## 使用示例 @@ -53,7 +57,7 @@ Magic-Doc 是一个轻量级、开源的用于将多种格式的文档(PPT/PPT # for local file from magic_doc.docconv import DocConverter, S3Config converter = DocConverter(s3_config=None) -markdown_cotent, time_cost = converter.convert("some_doc.pptx", conv_timeout=300) +markdown_content, time_cost = converter.convert("some_doc.pptx", conv_timeout=300) ``` ```python @@ -62,7 +66,7 @@ from magic_doc.docconv import DocConverter, S3Config s3_config = S3Config(ak='${ak}', sk='${sk}', endpoint='${endpoint}') converter = DocConverter(s3_config=s3_config) -markdown_cotent, time_cost = converter.convert("s3://some_bucket/some_doc.pptx", conv_timeout=300) +markdown_content, time_cost = converter.convert("s3://some_bucket/some_doc.pptx", conv_timeout=300) ``` @@ -79,6 +83,17 @@ markdown_cotent, time_cost = converter.convert("s3://some_bucket/some_doc.pptx", | DOCX | 1482 (page/s) | +## 🖊️ 引用 + +```bibtex +@misc{2024magic-doc, + title={Magic-Doc: A Toolkit that Converts Multiple File Types to Markdown}, + author={Magic-Doc Contributors}, + howpublished = {\url{https://github.com/InternLM/magic-doc}}, + year={2024} +} +``` + ## 开源许可证 diff --git a/setup.py b/setup.py index 88a251f..3361beb 100644 --- a/setup.py +++ b/setup.py @@ -43,7 +43,7 @@ def parse_requirements(filename): long_description_content_type='text/markdown', install_requires=parse_requirements("requirements.txt"), # 项目依赖的第三方库 url="https://github.com/InternLM/magic-doc", - python_requires=">=3.10", # 项目依赖的 Python 版本 + python_requires="==3.10", # 项目依赖的 Python 版本 entry_points={ "console_scripts": [ "magic-doc=magic_doc.cli:cli_conv",