https://github.com/p403n1x87/erwin
Erwin likes putting stuff in boxes. He's simultaneously useless and useful until you try him.
https://github.com/p403n1x87/erwin
cloud-storage-application file-synchronization
Last synced: 2 months ago
JSON representation
Erwin likes putting stuff in boxes. He's simultaneously useless and useful until you try him.
- Host: GitHub
- URL: https://github.com/p403n1x87/erwin
- Owner: P403n1x87
- License: gpl-3.0
- Created: 2020-01-31T09:45:30.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-05-17T11:25:55.000Z (about 5 years ago)
- Last Synced: 2025-01-31T10:14:34.552Z (4 months ago)
- Topics: cloud-storage-application, file-synchronization
- Language: Python
- Size: 133 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE-OF-CONDUCT.md
Awesome Lists containing this project
README
Meet Erwin
Erwin likes to put stuff in boxes for safekeeping and
synchronisation across devices, using Google Drive as cloud storage service.
He's both useless and useful, until you try him for the first time :).
Synopsis •
Installation •
Usage •
Why Erwin •
Compatibility •
Contribute
# Synopsis
⚠️ WARNING Erwin is still in beta and not extensively tested. Whilst your
remote files are pretty safe, it cannot be completely excluded at the moment
that local files won't be lost. Use at your own risk, and if you do, please
always make backup copies of important files first!
Erwin is a cloud storage synchronisation service. Currently, it works with Google
Drive and allows you to have a local mirror copy of the files stored on your
Google Drive account.
There are some known **restrictions** at the moment. There is no support for
Google Docs, which means that you won't see these files in your local copy.
Furthermore, Google Drive allows for multiple files to have the same name within
the same directory. Most local file systems don't allow for a similar thing, so
Erwin will work as expected for you only if you make sure never to use the same
name for files within the same folder.
# Installation
Erwin can be installed directly from GitHub with
~~~ bash
pip install git+https://github.com/P403n1x87/erwin
~~~
# Usage
Once installed, Erwin can be launched with
~~~
erwin
~~~
On the first boot, you will be prompted to enter some configuration, like an
alias for your account, and the path where you want the files to be synchronised
locally (e.g. `/home/gabriele/GoogleDrive`).
It is recommended to wrap Erwin around a systemd (user) service for easy control
and automatic startup on login (see, e.g.,
https://wiki.archlinux.org/index.php/Systemd/User for details).
# Why Erwin
Erwin is similar to other Google Drive solutions like
[google-drive-ocamlfuse](https://github.com/astrada/google-drive-ocamlfuse), the
main difference being that it behaves more like services such as Dropbox. Files
are synchronised from the remote cloud storage to the local file system. This
means that your files will be available even when you are offline. Any changes
are pushed and pulled as soon as they are available and your system is connected
to the public network.
# Compatibility
Erwin has been tested with Python 3.6 on Ubuntu 18.04.
# Contribute
Any help with improving Erwin is very welcome :).