Metadata-Version: 2.4
Name: overleaf-git-unipi
Version: 1.1.3
Summary: A client to bridge GIT and your overleaf projects (community edition)
Home-page: https://github.com/robol/python-overleaf-git-unipi
Author: Leonardo Robol
Author-email: leo@robol.it
Keywords: sharelatex,client,overleaf,git
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
License-File: LICENSE
Requires-Dist: socketIO-client==0.5.7.4
Requires-Dist: websocket-client==0.59.0
Requires-Dist: click~=8.0
Requires-Dist: GitPython~=2.1.13
Requires-Dist: filetype~=1.0.5
Requires-Dist: keyring<23.9.0,>=17.1.1
Requires-Dist: lxml>=4.3.3
Requires-Dist: python-dateutil>=2.7.3
Requires-Dist: appdirs>=1.4.3
Requires-Dist: requests>=2.27.0
Provides-Extra: admin
Requires-Dist: pymongo~=4.0; extra == "admin"
Provides-Extra: bench
Requires-Dist: locust; extra == "bench"
Dynamic: license-file

Python-overleaf-git-unipi is a small project derived from [Python-sharelatex](https://gitlab.inria.fr/sed-rennes/sharelatex). It has been slightly modified and adapted to suit the need for the local installation at https://overleaf.unipi.it, but should work against any Overleaf instance. 

See [FAQ.md](FAQ.md) for answers to common installation and synchronization questions.

## Installation

The recommended way to install or update `git-overleaf` is to run the installer directly from GitHub:

```sh
curl https://raw.githubusercontent.com/robol/python-overleaf-git-unipi/refs/heads/main/install.sh | bash
```

The script creates a virtual environment under `~/.local/share/python-overleaf-git-unipi`, installs the package there, and adds `git-overleaf` to your PATH through `~/.profile`.
The script can be run multiple times to update the `git-overleaf` module.

## Quick usage

Clone an Overleaf project by passing its project URL:

```sh
git overleaf clone https://overleaf.unipi.it/project/<project-id>
```

You can also choose the local directory name:

```sh
git overleaf clone https://overleaf.unipi.it/project/<project-id> my-paper
```

Inside the cloned project directory, pull changes from Overleaf with:

```sh
git overleaf pull
```

Push committed local changes back to Overleaf with:

```sh
git overleaf push
```

Before running `git overleaf pull` or `git overleaf push`, the git working tree must be clean: there must be no uncommitted changes and no untracked files. Check with:

```sh
git status
```

Commit or stash changes you want to keep before synchronizing. The pull and push commands will
only run with a clean tree, that you can always obtain by running.

```sh
git clean -fd
```

Be careful: `git clean -fd` permanently deletes untracked local files and directories. Run `git clean -fdn` first to preview what would be deleted.
