Template compliance checker and safe formatter for academic papers
Project description
简体中文 | English
paperfmt
学术论文模板合规检查与安全修复工具。
解析 .tex 多文件项目,生成可读报告,一键修复格式问题。
快速开始
# 在论文项目目录下初始化
paperfmt init --template ieee-conf
# 运行检查
paperfmt check
# 一键修复
paperfmt fix
支持模板
| 模板 | 标识 | 规则数 | 说明 |
|---|---|---|---|
| IEEE 会议 | ieee-conf |
12 | IEEE 会议论文格式 |
| ACM 会议 | acm-conf |
12 | ACM 会议论文格式 |
| NeurIPS | neurips |
12 | NeurIPS 会议论文格式 |
| ACL 会议 | acl-conf |
12 | ACL 会议论文格式 |
所有模板均包含 10 项通用规则(引用检查、标签验证、分辨率检查等)。
详细内容见 规则列表。
命令一览
| 命令 | 用途 |
|---|---|
paperfmt init |
初始化项目,创建 paperfmt.toml 和 .paperfmt/ |
paperfmt check |
检查 .tex 文件,支持 --strict CI 模式、--format json 等 |
paperfmt fix |
安全修复,支持 --dry-run 预览、--interactive 逐条确认 |
详细用法见 命令参考。
配置
paperfmt.toml 示例:
main_tex = "paper.tex"
bibliography = "refs.bib"
[rules.IEEE006]
enabled = false # 关闭匿名泄露检查
[rules.IEEE007]
severity = "warning" # DOI 缺失降级为警告
执行记录自动追加至 .paperfmt/report.txt。
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file paperfmt-1.0.1.tar.gz.
File metadata
- Download URL: paperfmt-1.0.1.tar.gz
- Upload date:
- Size: 28.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
063e586a2b45fb39ef96973bcee80240f893cbccc027fb9ca2056407e555f5aa
|
|
| MD5 |
6764c7a40e7bbfc3442f40d5cfef2eaf
|
|
| BLAKE2b-256 |
c3bf1c576a86f59249da049f29d23a6342b21cca5871c8b42eb470167dabf540
|
Provenance
The following attestation bundles were made for paperfmt-1.0.1.tar.gz:
Publisher:
publish.yml on Shionyori/paperfmt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
paperfmt-1.0.1.tar.gz -
Subject digest:
063e586a2b45fb39ef96973bcee80240f893cbccc027fb9ca2056407e555f5aa - Sigstore transparency entry: 1581396853
- Sigstore integration time:
-
Permalink:
Shionyori/paperfmt@3631d932e11c4b2e18e404362f798d724e8d9802 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/Shionyori
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3631d932e11c4b2e18e404362f798d724e8d9802 -
Trigger Event:
push
-
Statement type:
File details
Details for the file paperfmt-1.0.1-py3-none-any.whl.
File metadata
- Download URL: paperfmt-1.0.1-py3-none-any.whl
- Upload date:
- Size: 29.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f6fa43635922d030072ee1fd1f18a1e742922bf2ff8ac4867ff749941d8ecde3
|
|
| MD5 |
b35d3aa14acffc20b05a4128573276c5
|
|
| BLAKE2b-256 |
2127332c96e40b258f0e5731f4a370a0d389689406049e439fa3748f3411edd6
|
Provenance
The following attestation bundles were made for paperfmt-1.0.1-py3-none-any.whl:
Publisher:
publish.yml on Shionyori/paperfmt
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
paperfmt-1.0.1-py3-none-any.whl -
Subject digest:
f6fa43635922d030072ee1fd1f18a1e742922bf2ff8ac4867ff749941d8ecde3 - Sigstore transparency entry: 1581396933
- Sigstore integration time:
-
Permalink:
Shionyori/paperfmt@3631d932e11c4b2e18e404362f798d724e8d9802 -
Branch / Tag:
refs/tags/v1.0.1 - Owner: https://github.com/Shionyori
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@3631d932e11c4b2e18e404362f798d724e8d9802 -
Trigger Event:
push
-
Statement type: