{"id":13512280,"url":"https://github.com/mfuentesg/SyncSettings","last_synced_at":"2025-03-30T22:32:24.524Z","repository":{"id":35694762,"uuid":"39971725","full_name":"mfuentesg/SyncSettings","owner":"mfuentesg","description":"Sync Settings - The cross-platform solution to keep Sublime Text configuration synchronized","archived":false,"fork":false,"pushed_at":"2022-12-09T05:18:46.000Z","size":844,"stargazers_count":288,"open_issues_count":10,"forks_count":37,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-05-23T06:06:34.509Z","etag":null,"topics":["configuration","gist","sublime-text","sync-settings","synchronization"],"latest_commit_sha":null,"homepage":"https://mfuentesg.dev/SyncSettings","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mfuentesg.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"open_collective":"syncsettings"}},"created_at":"2015-07-30T20:46:21.000Z","updated_at":"2024-03-06T16:07:51.000Z","dependencies_parsed_at":"2023-01-16T03:15:22.700Z","dependency_job_id":null,"html_url":"https://github.com/mfuentesg/SyncSettings","commit_stats":null,"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfuentesg%2FSyncSettings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfuentesg%2FSyncSettings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfuentesg%2FSyncSettings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mfuentesg%2FSyncSettings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mfuentesg","download_url":"https://codeload.github.com/mfuentesg/SyncSettings/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246390883,"owners_count":20769475,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["configuration","gist","sublime-text","sync-settings","synchronization"],"created_at":"2024-08-01T03:01:40.976Z","updated_at":"2025-03-30T22:32:20.331Z","avatar_url":"https://github.com/mfuentesg.png","language":"Python","funding_links":["https://opencollective.com/syncsettings","https://www.buymeacoffee.com/mfuentesg"],"categories":["Python","Extensions"],"sub_categories":["General Purpose"],"readme":"# UNMAINTAINED\n\nSadly, I won't able to continue with the development of SyncSettings, it will be available on package control registry but won't receive new changes.\n\nSyncSettings has been a very challenging project and it tought me how to cope with a community and learn more about the open source world.\nThanks for all the support during this time and I hope that SyncSttings remains being so useful like it was for me.\n\nHappy Coding!\n\nMarcelo\n\n---\n\n# Sync Settings\n\u003c!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --\u003e\n[![All Contributors](https://img.shields.io/badge/all_contributors-6-orange.svg?style=flat-square)](#contributors-)\n\u003c!-- ALL-CONTRIBUTORS-BADGE:END --\u003e\n\n[![SyncSettings](https://img.shields.io/packagecontrol/dt/Sync%20Settings.svg?maxAge=2592000)](https://packagecontrol.io/packages/Sync%20Settings)\n[![license](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)](https://img.shields.io/github/license/mashape/apistatus.svg?maxAge=2592000)\n[![SyncSettings release](https://img.shields.io/github/release/mfuentesg/SyncSettings.svg)](https://img.shields.io/github/release/mfuentesg/SyncSettings.svg?maxAge=2592000)\n[![Build Status](https://travis-ci.org/mfuentesg/SyncSettings.svg?branch=master)](https://travis-ci.org/mfuentesg/SyncSettings)\n[![Coverage](https://img.shields.io/codecov/c/github/mfuentesg/SyncSettings.svg?style=flat)](https://codecov.io/gh/mfuentesg/SyncSettings)\n\n\u003ca href=\"https://www.buymeacoffee.com/mfuentesg\" target=\"_blank\"\u003e\n   \u003cimg height=\"41\" src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" /\u003e\n\u003c/a\u003e\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\nWith [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings), you are able to synchronize your [Sublime Text](http://sublimetext.com/) settings among multiple devices, and keep them updated.\n\nBeing powered by GitHub-Gists, [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings) provides you a reliable cross-platform solution to keep your backups secure.\n\nPlease, follow the steps below to getting started with [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings).\n\n\u003e [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings) works on Windows, Linux, macOS and [Sublime Text 3](http://sublimetext.com/3).\n\n\n## Getting Started\n\n1. Run `Package Control: Install Package` command, and looks for [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings)\n2. Run `Sync Settings: Edit User Settings`\n3. **if** *Do you already have a gist?*\n    1. Copy `gist id` and put it in config file (`https://gist.github.com/\u003cusername\u003e/\u003cgist id\u003e`) (`gist_id` property)\n    2. Run `Sync Settings: Download` command to retrieve your backup.\n4. **else**\n    1. Create an access token [here](https://github.com/settings/tokens/new) with `gist` scope checked.\n    2. Put the token in the config file (`access_token` property)\n    3. Run `Sync Settings: Create and Upload` command\n    \n### File Format\n\nPlease note - the config file uses the JSON format. A simplified example may look like the following.\n\n```\n{\n\t\"access_token\": \"xxxxxxxxxxxxxxxxxxxxxxxxx\",\n\t\"gist_id\": \"xxxxxxxxxxxxxxxxxxxxxxxxx\"\n}\n```\n\n## Options\n\nBy default, this plugin operates over [Sublime Text](https://www.sublimetext.com) packages folder (i.e `/Users/\u003cmy_user\u003e/Library/Application Support/Sublime Text 3/Packages/User`), which means, `excluded_files` and `included_files` will look for files inside that folder.\n\n| name | type | description |\n|---|---|---|\n| `access_token`  | `string` | Brings write permission to [Sync Settings](https://packagecontrol.io/packages/Sync%20Settings) over your gists (edit, delete and create). *(This option is not required, if you only want to download your backups)* | \n| `gist_id`  | `string` | Identifier of your backup on [gist.github.com](https://gist.github.com). |\n| `auto_upgrade`  | `boolean` | If is `true`, your settings will be synced with the latest settings on [gist.github.com](https://gist.github.com) when [Sublime Text](https://www.sublimetext.com) startup |\n| `http_proxy`  | `string` | An HTTP proxy server to use for requests. |\n| `https_proxy`  | `string` | An HTTPS proxy server to use for requests. |\n| `excluded_files`  | `[]string` | In simple words, this option is a black list. Which means, every file that match with the defined pattern, will be ignored on sync. |\n| `included_files`  | `[]string` | In simple words, this option is a white list. Which means, every file that match with the defined pattern, will be included on sync, even if it was included on `excluded_files` option. |\n\n\u003e Note: `excluded_files` and `included_files` are patterns defined as [unix shell style](https://tldp.org/LDP/GNU-Linux-Tools-Summary/html/x11655.htm).\n\n\n## Commands\n\n| command | description |\n|---|---|\n|**Sync Settings: Create and Upload**|Creates a new backup on `gist.github.com` from your local files|\n|**Sync Settings: Delete and Create**|Deletes the remote reference of your gist and then, creates a new backup from your local files to `gist.github.com`|\n|**Sync Settings: Upload**|Upload a backup from your local files to `gist.github.com`|\n|**Sync Settings: Download**|Retrieves the latest version of your backup, using as reference the `gist_id` property defined in your settings file.|\n|**Sync Settings: Delete**|Deletes the remote version of your gist, using as reference the `gist_id` property defined in your settings file. (This action is irreversible)|\n|**Sync Settings: Show Logs**|Open a new view, with `Sync Settings` log file|\n|**Sync Settings: Edit User Settings**|Open a new view, with `Sync Settings` user settings.|\n\n## Contributors\n\nThank you for contribute to this project:\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://ferronrsmith.github.io/\"\u003e\u003cimg src=\"https://avatars2.githubusercontent.com/u/159764?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eFerron H\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=ferronrsmith\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/tomahl\"\u003e\u003cimg src=\"https://avatars0.githubusercontent.com/u/1665481?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003etomahl\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=tomahl\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://nachvorne.de\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/2073401?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eJohannes Weber\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=JohaWeber\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://mwilliammyers.com\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/2526129?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eWilliam Myers\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=mwilliammyers\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/TheSecEng\"\u003e\u003cimg src=\"https://avatars1.githubusercontent.com/u/32599364?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eTerminal\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=TheSecEng\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://github.com/mariohuq\"\u003e\u003cimg src=\"https://avatars.githubusercontent.com/u/15021607?v=4?s=100\" width=\"100px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003emariohuq\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"https://github.com/mfuentesg/SyncSettings/commits?author=mariohuq\" title=\"Code\"\u003e💻\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n## Issues\n\nIf you are experimenting an error, or an unusual behavior. Please let me know,  creating a [new issue](https://github.com/mfuentesg/SyncSettings/issues/new) appending the logs provided by the  `Sync Settings: Show logs` command.\n\n## Development\n\nYou are welcome to contribute to this project, whenever you want.\n\n**Install dependencies**\n\nThis project uses pipenv as environment and package manager, follow the instructions below and start contributing.\n\n```\n$ pipenv --python 3.7\n$ pipenv install\n```\n\n**Run tests**\n\n```\n$ pipenv run nosetests tests\n```\n\n\n## License\n\nSync Settings is licensed under the MIT license along with all source code.\n\n```\nCopyright (c) since 2015, Marcelo Fuentes \u003cmarceloe.fuentes@gmail.com\u003e.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n\n## Help me keep making awesome stuff\n\nContribute with me, supporting this project through\n\n[![Become a backer](https://opencollective.com/syncsettings/tiers/backer.svg?avatarHeight=50)](https://opencollective.com/syncsettings)\n\n[![Become a backer](https://upload.wikimedia.org/wikipedia/commons/thumb/b/b5/PayPal.svg/100px-PayPal.svg.png)](https://opencollective.com/syncsettings)\n\n\u003ca href=\"https://www.buymeacoffee.com/mfuentesg\" target=\"_blank\"\u003e\n   \u003cimg height=\"41\" src=\"https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png\" alt=\"Buy Me A Coffee\" /\u003e\n\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfuentesg%2FSyncSettings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmfuentesg%2FSyncSettings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmfuentesg%2FSyncSettings/lists"}