Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/souvikinator/synko
[abandoned] 🔁 Sync application configurations and settings across multiple multi-platform devices 🖥️💻 (linux and macos)
https://github.com/souvikinator/synko
backup cli cli-tool configuration hacktoberfest hacktoberfest-accepted hacktoberfest2021 linux osx python python3 settings sync synchronization synko
Last synced: 4 months ago
JSON representation
[abandoned] 🔁 Sync application configurations and settings across multiple multi-platform devices 🖥️💻 (linux and macos)
- Host: GitHub
- URL: https://github.com/souvikinator/synko
- Owner: souvikinator
- License: gpl-3.0
- Created: 2021-10-11T14:40:17.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-10-23T11:20:03.000Z (over 3 years ago)
- Last Synced: 2024-09-17T14:00:04.182Z (5 months ago)
- Topics: backup, cli, cli-tool, configuration, hacktoberfest, hacktoberfest-accepted, hacktoberfest2021, linux, osx, python, python3, settings, sync, synchronization, synko
- Language: Python
- Homepage: https://pypi.org/project/synko/
- Size: 1.12 MB
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
sync application configuration and settings across multiple multiplatform devices
✨ Key Features •
⚗️ Installation •
📑 How To Use •
🤔 FAQ •
🛠️ Setup •
👨🧑 Contribution
# ✨ Features
> **Synko is still in development phase and is not tested throughly, so it is recommended to take backup of the config files before adding to synko. As any bug may lead to loss of data.**
- Sync application settings and configuration files across multiple devices (linux and macos)
- Works with dropbox (Read [FAQ](#-FAQ) to know more)
- User gets the freedom to add path to the config and setting files.
- Freedom to sync specific set of files across specific set of devices. Here is an example:
# ⚗️ Install
Install synko with pip
> **NOTE:** If on using `command not found: synko` or similar message shows up then try running the above command as root user (`sudo`)
```bash
pip install synko
```
# 📑 How to use
> **Note**: on first usage of Synko it'll look for Dropbox directory and if not found, it will prompt to enter the path to dropbox. Also synko needs to register you device so it will prompt to enter device name which can be anything you want as long as it's not conflict with pre-registered devices. Here is how it looks:
>
> In gif below, synko is running in **[WSL (Windows Subsystem Linux)](https://docs.microsoft.com/en-us/windows/wsl/about)** and my dropbox folder is the Windows so I had to change the dropbox path to the one in windows for it to work properly.
>
> 
>
> In case one want's to change/update the storage path anytime later then use `synko info -p path/to/storage`
## Add
**Usage:** `synko add [paths...] --config-name="configname"`
> ### **adding files to synko**
>
> `config-name` can be anything, synko will add provided paths under the config name
>
> 
> ### **add multiple files to synko**
>
> **Note:** if `--config-name / -c` option is not used then it prompts to enter the config name as seen in below gif
>
> 
> ### **adding files under same config name**
>
> one can also add files to existing config names like so:
>
> `synko add ~/.config/random_app/newfile -c existing_config_name`
> ### **How to sync?**
>
> Suppose there are two devices **A** and **B**. In device **A** you added a file like so:
>
> **Device A**: `synko add ~/.config/random_app/a.conf --config-name=config1`
>
> the file will be saved under config name "**config1**". In order to sync this file with device "**B**" you need to make sure that the file with similar name (**a.conf** in this case) already exists in device "**B**". If does not exist then create an empty file.
> After doing so you just need to add the file to synko in device **B** under the same config name used in device **A** (**config1** in this case) like so:
>
> **Device B**: `synko add ~/.config/random_app/a.conf --config-name=config1`
>
> below is a demo
> 
>
> It may also be possible that **a.conf** already exists in device **B** with some content which may differ from the one in device **A**. Conflict arise and user is given the options to choose which one's content should be saved:
>
> 
Current process of syncing is bit tideous as of now but more changes will be made to make the process relatively easy.
## Index
**Usage:** `synko index`
> ### list all the added configurations
>
> `synko index`
>
> 
## Remove
**Usage:** `synko remove [options]`
> ### **remove specific configuration/settings file added to synko**
>
> `synko remove --config-name configuration_name_here`
>
> it asks to select one or multiple files one wants to remove from synko, user **right arrow key to select** and **left arrow key to unselect** , **up and down arrow key** to navigate.
> 
If you don't want to remove any then select nothing and press enter, the process will be aborted
> ### **remove all config files added to Synko on current device for syncing (this won't affect other devices)**
>
> `synko remove -a`
>
> 
## Info
**Usage**: `synko info [options]`
> ### **displaying current synko settings**
>
> `synko info`
>
> 
> ### **updating storage path**
>
> `synko info -p path/to/storage/dir`
>
> 
>
> in gif above synko is running in **[WSL (Windows Subsystem Linux)](https://docs.microsoft.com/en-us/windows/wsl/about)** and my dropbox folder is the Windows so I had to change the dropbox path to the one in windows for it to work properly.
## Reset
**Usage**: `synko reset`
> ### Reset synko completely, (fresh as new)
>
> This removes all the files added to synko on current device and also resets synko by unregistering you device and the storage path. So next time you run any synko command, you'll be prompted to register your device and if the default storage path is not found then you'll be prompted to enter storage path.
>
> 
>
> In the gif above you can see that after reset command, the time when any other synko command is executed it prompts to register device.
# 🤔 FAQ
## Only Dropbox supported?
Well synko works with **any cloud storage syncing solution** as long as all the devices use the same solution. You just need to provide synko with the path to the folder which is getting synced by the **cloud storage syncing solution**. Dropbox is the best one to go with as it has support for mutiple platforms.
# 🛠️ Setup
## **Install dependencies**
> ### using pipenv
>
> `pipenv install`
> ### using pip
>
> `pip3 install -r requirements.txt`
## **Run:**
After making changes make sure to run below command
```bash
sudo python3 setup.py install
```
now to run, directly use `synko` command.
# 👨🧑 Contribution
> **If you are interested in helping with project development, see [contribution guide](https://github.com/souvikinator/synko/blob/master/CONTRIBUTING.md) to find a set of tips.**