{ "info": { "author": "Samuel Smoker", "author_email": "smoker@usc.edu", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: End Users/Desktop", "Intended Audience :: System Administrators", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Natural Language :: English", "Programming Language :: Python :: 3.4", "Topic :: System :: Archiving :: Mirroring", "Topic :: Utilities" ], "description": "# syncthingmanager\nA command line tool for the Syncthing API. Designed to make setting up remote servers easier.\n(and for users who prefer the cli)\n\n## Installation and configuration\n###Requirements\n- Python 3.4 or later\n- setuptools and pip\n- Syncthing 0.14.19 or later\n\n`pip3 install syncthingmanager`\n\nThe configuration must be initialized with the Syncthing API key.\nUsually this can be done automatically:\n`stman configure`. If that doesn't work, get the API key from the GUI \nor config.xml (in Syncthing's config directory), then run `stman configure apikey`.\n\n### Configuration syntax\nIf your Syncthing GUI/API is on a non-standard port, or not on localhost, \nyou will need to configure it manually. By default, `stman` will look for \nsettings at `~/.config/syncthingmanager/syncthingmanager.conf`. \nA sample syncthingmanager.conf follows:\n\n```\n[DEFAULT]\nname = localhost\n\n[localhost]\napikey = MafkDvpagX5J6oMzxm9HwDSXJPSQKPFS\nhostname = localhost\nport = 8384\n\n[remote-device]\napikey = h9mifaKwDq3SSPPmgUuDjsrivFg3dtkK\nhostname = some-host\nport = 9001\n```\n\nIn this example, my default device is the one at localhost:8384. If I wanted \nto send a command to the one at some-host:9001, it would look like \n`stman --device remote-device ...`\n\n## Usage\n```\n$ stman device list\n$HOME/.config/syncthingmanager/syncthingmanager.conf doesn't appear to be a valid path. Exiting.\n# Autoconfiguration\n$ stman configure\n# List configured devices\n$ stman device list\nsyncthingmanager-test This Device\n ID: LYAB7ZG-XDVMAVM-OUZ7EAB-5N3UVWY-DXTFRJ4-U2MTHGQ-7TIBRJE-PC56BQ6\n\nanother-device Connected\n At: # Address removed\n Folders: dotest\n ID: H2AJWNR-5VYNWKM-PS2L2EE-QJYBG2U-3IFN5XM-EKSIIKF-NVLAG2E-KIQE4AE\n# List configured folders\n$ stman folder list\nDefault Folder\n Shared With: \n Folder ID: default\n Folder Path: /home/syncthing/Sync/\n\ndo-test\n Shared With: another-device\n Folder ID: dotest\n Folder Path: /home/syncthing/stman-test/\n# Adding a device\n$ stman device add MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD -n yet-another-device -i\n\n$ stman device list\nsyncthingmanager-test This Device\n ID: LYAB7ZG-XDVMAVM-OUZ7EAB-5N3UVWY-DXTFRJ4-U2MTHGQ-7TIBRJE-PC56BQ6\n\nanother-device Connected\n At: #Address removed\n Folders: dotest\n ID: H2AJWNR-5VYNWKM-PS2L2EE-QJYBG2U-3IFN5XM-EKSIIKF-NVLAG2E-KIQE4AE\n\nyet-another-device Not Connected\n Folders: \n ID: MFZWI3D-BONSGYC-YLTMRWG-C43ENR5-QXGZDMM-FZWI3DP-BONSGYY-LTMRWAD\n# Share a folder with a device\n$ stman folder share dotest yet-another-device\n$ stman folder list\nDefault Folder\n Shared With: \n Folder ID: default\n Folder Path: /home/syncthing/Sync/\n\ndo-test\n Shared With: another-device, yet-another-device\n Folder ID: dotest\n Folder Path: /home/syncthing/stman-test/\n# Configure and view advanced options\n$ stman folder versioning dotest simple --versions 15\n$ stman folder edit dotest -r 70\n$ stman folder info dotest\ndo-test\n Shared With: another-device, yet-another-device\n Folder ID: dotest\n Folder Path: /home/syncthing/stman-test/ \n Rescan Interval: 70\n File Pull Order: alphabetic\n Versioning: simple\n Keep Versions: 15\n```\n\nOther commands are documented in `stman -h`, `stman command -h`, and so on.\n\n\n## Notes\n- On Windows, cmd.exe will print funny characters in place of colors.\nPowerShell works fine.\n- Some information shown in the GUI requires use of the Events API, which\nisn't part of python-syncthing. I plan on creating Python bindings for it\nand using the results, but haven't started yet.\n- I chose to have the device list output be online first instead of \nalphabetical.\n", "description_content_type": null, "docs_url": null, "download_url": null, "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/classicsc/syncthingmanager", "keywords": "syncthing", "license": "GPLv3", "maintainer": null, "maintainer_email": null, "name": "syncthingmanager", "package_url": "https://pypi.org/project/syncthingmanager/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/syncthingmanager/", "project_urls": { "Homepage": "https://github.com/classicsc/syncthingmanager" }, "release_url": "https://pypi.org/project/syncthingmanager/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "A commandline tool for configuring Syncthing", "version": "0.1.0" }, "last_serial": 2682824, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "8a0741f28df3e2f37dd9a93bd833ad6a", "sha256": "3b3541e99fb05330bed1d33f0b46650b15b0d334a5f263015fc1f424f2813d9c" }, "downloads": -1, "filename": "syncthingmanager-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8a0741f28df3e2f37dd9a93bd833ad6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22539, "upload_time": "2017-03-04T21:21:52", "url": "https://files.pythonhosted.org/packages/c6/fc/8f03d27a4c227d0199d4285cbba7c68fc361d1d16a269742f4a52ac32315/syncthingmanager-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "8a0741f28df3e2f37dd9a93bd833ad6a", "sha256": "3b3541e99fb05330bed1d33f0b46650b15b0d334a5f263015fc1f424f2813d9c" }, "downloads": -1, "filename": "syncthingmanager-0.1.0.tar.gz", "has_sig": false, "md5_digest": "8a0741f28df3e2f37dd9a93bd833ad6a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 22539, "upload_time": "2017-03-04T21:21:52", "url": "https://files.pythonhosted.org/packages/c6/fc/8f03d27a4c227d0199d4285cbba7c68fc361d1d16a269742f4a52ac32315/syncthingmanager-0.1.0.tar.gz" } ] }