README.md · spider/PyTex

# PyTex

[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)![Upload Python Package](https://github.com/zrr1999/PyTex/workflows/Upload%20Python%20Package/badge.svg)

本代码仓库已经不再进行维护，有使用Python代码生成LaTeX需求的用户可以考虑使用设计更加完善的 [BoneTeX](https://gitee.com/zrr1999/bonetex)（计划在五月前开源）。

本代码库使用了JelteF的[PyLaTex](https://github.com/JelteF/PyLaTeX) 代码并做了一定的修改。

PyTex主要用于简化LaTex的编写，你也可以把它当做一个MarkDown到LaTeX代码的转换工具。LaTeX语法并不是使用本库必须的要求，但是熟悉LaTeX语法有助于更好的使用本库。

## 优势
- LaTex
    1. 本辅助库可以有效避免拼写错误，漏加空格等低级错误。
    2. 本辅助库可以借助Python提供更多的功能。
    3. 本辅助库在插入图片、生成表格等方面有巨大优势。
- Word
    1. 本辅助库可以更加自由地编写文档。
    2. 本辅助库可以借助Python提供更多的功能。

## 安装[![Downloads](https://pepy.tech/badge/bone-pytex)](https://pepy.tech/project/bone-pytex)

这个项目使用 [Python](https://www.python.org/downloads/) 开发，
同时需要[LaTeX环境](https://zhuanlan.zhihu.com/p/136931926)，请确保你本地安装了它们。

建议使用pip安装本库。

```sh
$ pip install bone-pytex
```

## 使用说明

使用时，你必须创建一个文档实例。

```python
from pytex import MathDocument
doc = MathDocument('数学建模', packages=["amsmath", "graphicx", "amssymb", "cite"],
                   standard="GJS", preface=False)
```

如果你使用了默认的标准页，可以通过命令添加队伍信息

```python
doc.set_information(problem_num="A", team_num="0001", school_name="最强大学",
                    member_names=("a", "b", "c"), supervisor="teacher", date=(2020, 4, 20))
```

你可以将md文档转换为latex

```python
from pytex.utils import md2tex, MarkDown
latex_code1 = md2tex(path="examples/md/abstract.md")
latex_code2 = md2tex(file=open("examples/md/abstract.md", 'r', encoding='UTF-8'))
latex_code3 = MarkDown("md/abstract.md")
```

你可以在文档中添加标题、摘要、目录。

```python
doc.add_title()
keys = ["出租车资源配置", "供求匹配模型", "缓解程度判断模型", "分区域动态实时补贴方案"]
doc.add_abstract(latex_code, keys)
doc.add_toc()
```

你可以在文档中添加 使用固定格式编写的md文档 作为一个section。

```python
doc.add_section(path="examples/md/wtcs.md")
```

你可以在文档中添加指定标题和内容的 section。

```python
doc.add_section(title="符号说明", content="大家好啊")
```

你可以在文档中添加变量，将会自动添加到变量表中，同时还可以使用符号转化器将其转换为latex代码

```python
from pytex.utils import SymbolTransformer
from pylatex import NoEscape
x = doc.add_var("x", NoEscape("这是一个优秀的$x$"))
st = SymbolTransformer()
formula, name = st.sym2tex((x**2+7)*5)
```

最后，你可以生成tex文档，或者pdf文档

```python
doc.generate_pdf('resources/math', compiler='XeLatex', clean_tex=False, clean=False)
```

## MarkDown文档编写格式指南
在绝大多数情况下使用普通MarkDown即可，但有些功能是原生MarkDown不具备的，因此我们扩展了它的功能。

## 示例

完整代码可以参考demo结尾的几个文件。

## 特色功能
1. 提供了试卷编写模块，详情见pytex/exam/README.md。
2. 支持引用特定规范的Markdown文件。
3. 支持定义局部操作（由于功能定位不清楚暂时废弃）。例如:
   在经常用到导数和积分的局部区域将`\text{d}`定义为`\d`，
   而在其他区域将`\dot`定义为`\d`，
   注意定义命令符时应尽量避免歧义，
   例如若将`\text{d}`定义为`d`，则`ad`也会被错误识别。
4. 支持部分Markdown语法转LaTeX。
5. 伪代码编写。
6. 针对数模进行了大幅度优化，提供了高教社标准和西电标准（非官方）。

## 计划实现功能
1. 神经网络结构可视化，输入处理形状变换可视化。
2. 更好地和symbol交互。
3. Python端编辑公式。
3. Python端添加文献。
4. 图制作。

## 更新日志
- (2020.05.10) v0.1.7 发布
    - 完善MarkDown端伪代码编写。
- (2020.04.30) v0.1.6 发布
    - 支持MarkDown端伪代码编写。
- (2020.04.24) v0.1.5 发布
    - 支持MarkDown的图片、超链接、代码块到LaTex的转换。
- (2020.04.22) v0.1.4 发布
    - 完善了MarkDown到LaTex的转换功能。
    - 使用了成熟的MarkDown解析模块，对md的处理更自然了。
- (2020.04.17) v0.1.3 发布
    - 大幅度优化了数模模块。
    - 优化了结构。
    - 支持添加sympy变量。
- (2020.04.15) v0.1.2 发布
    - 增加了数模模块。
    - 调整了结构。
- (2020.04.11) v0.1.1 发布
    - 修复了部分问题。
- (2020.04.08) v0.1.0 发布
    - 实现了DocTree，用于将dict转化为文档结构。

## 维护者

[@詹荣瑞](https://github.com/tczrr1999)

## 如何贡献

非常欢迎你的加入！[提一个 Issue](https://github.com/tczrr1999/pytex/issues/new) 或者提交一个 Pull Request。

### 贡献者

感谢以下参与项目的人：
[@Lynn-Speng](https://github.com/Lynn-Speng)、
[@WilsonLuo19](https://github.com/WilsonLuo19)。

## 使用许可

spider/PyTex

简介

发行版

贡献者

近期动态

spider/PyTex .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

spider/PyTex