Skip to main content

Open source Google Workspace backup solution.

Project description

gwbackupy: Google Workspace™ backup and restore solution.

0.2.0 0.2.0

What is it?

Google Workspace™ backup and restore solution. Gwbackupy is open source and written in python.

Currently supported only the gmail messages.

Why?

Due to gmvault limitations:

  • authentication method is not usable in Google Workspace wide
  • is still abandoned (?)
  • only supports gmail messages

Currently implemented functionality

  • Google Workspace
    • authentication with p12 service account file.

      It can be applied to the entire workspace.

  • Gmail
    • full backup Download all messages
    • full backup continuously Scanning the full mailbox, but download only the new messages.
    • full restore to an empty mailbox At the moment, it does not check whether the message already exists, so if the account is not empty, duplicate messages are generated!
    • partially restore with pre-filtered files at the file system level

Additional functionality under development.

Functionality planned in the near future

  • Google Workspace
    • list all workspace accounts email addresses
  • Gmail
    • Support for standard gmail account authentication

    • Retention of deleted mails

      Purpose: to be easy to use even without additional snapshot storage.

    • Filtered restore

    • Live restore without duplicate mails.

      Currently not check email exists or not, and restoring forcely.

Install

pip install gwbackupy

Usage

Gmail

Backup

gwbackupy \
  --service-account-email <service-account-email> \
  --service-account-key-filepath <service-acount-p12-key-file> \
  --batch-size 5 \
  gmail backup \
  --email <mailbox email address>

Restore

gwbackupy \
  --service-account-email <service-account-email> \
  --service-account-key-filepath <service-acount-p12-key-file> \
  --batch-size 5 \
  gmail restore \
  --add-label "backup-restore-1231" \
  --add-label "more-restore-label" \
  --email <source backup mailbox email address> \
  --to-email <destination mailbox email address>

Contributing

...

Changelog

The changes are contained in CHANGELOG.md.

About

Márton Somogyi

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

gwbackupy-0.3.0-py3-none-any.whl (10.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page