Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/Eraiyanbupeterfrancis/AutoBackupTool/llms.txt

Use this file to discover all available pages before exploring further.

AutoBackupTool runs on any system with Python 3.8 or higher and internet access. This page walks you through cloning the repository, setting up an isolated virtual environment, and installing all required packages — with platform-specific instructions for Windows, macOS, and Linux.

​
Prerequisites

Before you install, confirm you have:
  • Python 3.8 or higher — check with python --version or python3 --version
  • A Google account with Google Drive — required for OAuth authentication and backup storage
  • Internet access — needed for the initial OAuth authorization and all Drive uploads

​
Installation

1

Clone the repository

Clone AutoBackupTool from GitHub and enter the project directory:
git clone https://github.com/Eraiyanbupeterfrancis/AutoBackupTool.git
cd AutoBackupTool
2

Create a virtual environment (optional)

Using a virtual environment keeps AutoBackupTool’s dependencies isolated from your system Python. This step is optional but recommended.
python -m venv venv
Then activate the environment for your platform:
venv\Scripts\activate
Your terminal prompt will show (venv) when the environment is active.
3

Install dependencies

Install all required packages from requirements.txt:
pip install -r requirements.txt
4

Verify the installation

Confirm all four packages installed correctly:
python -c "import cryptography, pydrive2, schedule, dotenv; print('All dependencies installed')"
If the command prints All dependencies installed, you’re ready to configure the app.

​
Package descriptions

AutoBackupTool depends on four third-party packages:
PackagePurpose
pydrive2Google Drive API v2 wrapper — handles OAuth2 authentication and file upload/download
cryptographyProvides cryptography.Fernet for symmetric authenticated encryption of backup archives
scheduleIn-process job scheduler for running daily and weekly backups without a system cron job
python-dotenvReads backup.env at startup and exposes ENCRYPTION_KEY and CLIENT_SECRETS_FILE as environment variables

​
Next steps

With dependencies installed, configure your Google Drive connection and encryption key:

Google Drive setup

Create an OAuth2 client in Google Cloud Console and download client_secrets.json

Encryption setup

Generate a Fernet key and create your backup.env configuration file

Build docs developers (and LLMs) love

Get started for freeTalk to us