Code Monkey home page Code Monkey logo

overleaf-backup-tool's Introduction

Overleaf backup tool

Tool for backing up projects from Overleaf.

Modify made to base repo

The original repo is at: https://github.com/tbmihailov/overleaf-backup-tool.git I have made the following modifications to enable a better support for:

  • Support for protected projects
  • Backups are listed by their name
  • Modified storage file structure

Installation

Works with Python 3.+

git clone https://github.com/zhanghan177/overleaf-backup-tool
cd overleaf-backup-tool
pip install -r requirements.txt

Usage

python overleaf_backup.py backup_dir [email protected] overleafpass

If you want to store your Overleaf credentials in environment variables, you could

cp app-env.example app-env

vim app-env # Update credentails in app-env

source app-env
python overleaf_backup.py backup_dir

How it works

The tool logins with your Overleaf username and password and downloads all projects under "active" and "archived" via git.

You will find the cloned projects folders in backup_dir/git_backup/:

your_backup_dir/
 ├── projects.json      # List of all projects
 ├── your-project-1-id
 │   ├── acl2018.bib
 │   ├── acl2018.sty
 │   ├── acl_natbib.bst
 │   ├── main.tex
 ├── your-project-2-id
 │   ├── acl2018.bib
 │   ├── acl2018.sty
 │   ├── acl_natbib.bst
 │   ├── main.tex

projects.json contains the metadata about the projects in Overleaf. Successfully backed up projects will not be downloaded again if they are not changed in Overleaf.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.