Overleaf-Sync 项目使用教程

Overleaf-Sync 项目使用教程

overleaf-sync Overleaf Two-Way Synchronization 项目地址: https://gitcode.com/gh_mirrors/ov/overleaf-sync

1. 项目的目录结构及介绍

Overleaf-Sync 项目的目录结构如下：

overleaf-sync/
├── olsync/
│   ├── __init__.py
│   ├── overleaf.py
│   ├── sync.py
│   └── utils.py
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── requirements.txt

目录结构介绍

• olsync/: 包含项目的主要代码文件。

  • init.py: 初始化文件，用于定义包。
  • overleaf.py: 处理与 Overleaf 的交互逻辑。
  • sync.py: 实现文件同步的核心功能。
  • utils.py: 包含一些工具函数。

• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。

• LICENSE: 项目的开源许可证文件，采用 MIT 许可证。

• README.md: 项目的说明文档，包含项目的基本信息和使用方法。

• pyproject.toml: 项目的配置文件，定义了项目的构建系统和依赖。

• requirements.txt: 列出了项目运行所需的 Python 依赖包。

2. 项目的启动文件介绍

Overleaf-Sync 项目的启动文件是 olsync/sync.py。该文件包含了项目的主要逻辑，负责处理本地文件与 Overleaf 项目之间的同步操作。

主要功能

• 同步本地文件到 Overleaf: 将本地修改的 .tex 文件同步到 Overleaf 项目中。
• 同步 Overleaf 文件到本地: 将 Overleaf 项目中修改的文件同步到本地。
• 处理文件冲突: 当本地和 Overleaf 项目中同时修改了同一文件时，提示用户选择保留哪个版本。

使用方法

在项目根目录下运行以下命令启动同步：

python -m olsync

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是项目的配置文件，定义了项目的构建系统和依赖。以下是文件的主要内容：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "overleaf-sync"
version = "0.1.0"
description = "Overleaf Two-Way Synchronization"
authors = [
    { name="Moritz Gloeckl", email="moritz@example.com" }
]
dependencies = [
    "requests",
    "PyQt5"
]

配置项说明

• build-system: 定义了构建系统的要求和后端。
• project: 定义了项目的基本信息，如名称、版本、描述、作者和依赖。

requirements.txt

requirements.txt 列出了项目运行所需的 Python 依赖包：

requests
PyQt5

这些依赖包可以通过以下命令安装：

pip install -r requirements.txt

总结

Overleaf-Sync 是一个用于实现本地与 Overleaf 项目双向同步的工具。通过本教程，您可以了解项目的目录结构、启动文件和配置文件的基本信息，并掌握如何启动和配置该项目。

overleaf-sync Overleaf Two-Way Synchronization 项目地址: https://gitcode.com/gh_mirrors/ov/overleaf-sync