Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Changes In Branch master Excluding Merge-Ins
This is equivalent to a diff from 5e442de3d4 to 44025db081
2019-03-10
| ||
01:51 | Typo, should have been file not filename Leaf check-in: 44025db081 user: atomicules tags: master, trunk | |
2018-11-17
| ||
10:59 |
Break many more common bits out into methods:
- snitems (iterating through items) | |
2014-04-06
| ||
10:14 | WIP on master: 4d13cca Merge branch 'master' of github.com:atomicules/snose Leaf check-in: 557b21d630 user: base@atomicules.co.uk tags: refs/stash, trunk | |
10:14 | index on master: 4d13cca Merge branch 'master' of github.com:atomicules/snose check-in: 9fecfecb39 user: base@atomicules.co.uk tags: refs/stash, trunk | |
2014-02-11
| ||
12:20 | Re-license as BSD 2-Clause check-in: c2dcf75092 user: atomicules@users.noreply.github.com tags: master, trunk | |
2013-11-15
| ||
00:01 |
Merge branch 'master' of github.com:atomicules/snose
Pull in license changes added directly on Github Leaf check-in: 5e442de3d4 user: base@atomicules.co.uk tags: origin/master, trunk | |
2013-11-14
| ||
23:59 |
Add rollback version functionality
Adds `blow` command that roles back local and remote note exactly one | |
2013-07-16
| ||
11:44 | Create LICENSE check-in: d110cbb8df user: atomicules@lavabit.com tags: origin/master, trunk | |
Changes to LICENSE.
|
| < | | < < < < < < < < | < | < < < < < < < < | < < | < < < < < < < < < | < < < | | < < < < < < < < < < < < < < < < < > | | | | | | < < < < < < < < < < | < < < < < < < < < < < < < < < < < < < < < | < | < < < < < < < < < < < < < < < < < < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | Copyright (c) 2014, atomicules All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Changes to README.md.
|
| | | | | > > | | | | | | | | > > > > > > | | | | | | | | | | | < | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 | # SNose - Simplenote Object Synchronisation (Explicit) A command line client / python script using the [Simplenote.py](https://github.com/mrtazz/simplenote.py) module from [mrtazz (Daniel Schauenberg)](https://github.com/mrtazz) that allows you to synchronise just the (text) files you specify within a directory across multiple machines. ## FAQ 1. You thought of the name "snose" first and then tried to wangle in something to make it an acronym, didn't you? *Yes.* ## Inspiration Basically I wanted a way to synchronise arbitrary "dotfiles" without the "expense" of a Git repository: - Git seems a bit overkill - I'm not really bothered about versioning, just synchronisation - I just want to synchronise *some* files within a directory, not all of them (just imagine the `.gitignore`!) ## How to use Will probably work in Python 2 and 3 (and was initially developed under Python 2), but I've taken to using 3 as much as I can day to day so I won't be catching bugs for 2. ### In general - Authentication Probably the best way is to store your credentials in `.netrc` with a `machine` of host "simple-note.appspot.com" and using the `login` and `password` entries. But you can also provide the username and password on the command line like so: python snose.py --username=me@email.com --password=mypassword A token based approach would be nice, but for that I'd need to modify simplenote.py. ### Snort - Importing a new file Take a file from the current directory and import into Simplenote as a new note: python snose.py --username=<me@email.com> --password=<mypassword> --snort --file=<filename.ext> Note that snose works with with files in subdirectories as well, etc. The only issue I could see there would be cross-platform. I.e. path differences between Windows and \*Nix. ### Sniff - Importing an existing file Take a file from the current directory and "match" it to an existing note within Simplenote python snose.py --username=<me@email.com> --password=<mypassword> --sniff=<key> --file=<filename.ext> Where key is the id used by Simplenote to identify the note. So the best way to find this is to make sure the noted is tagged as "snose" in Simplenote and then you can use `snose.py --snot` to find the key. ### Sneeze - Export an existing file Export a file from Simplenote to the current directory. python snose.py --username=<me@email.com> --password=<mypassword> --sneeze=<key> --file=<filename.ext> Alternatively Snose can try to be clever: If you have `file:filename.txt` in the first three lines of the file (in a comment, etc) then you can do: python snose.py --username=<me@email.com> --password=<mypassword> --sneeze=<key> And it'll try and figure out the filename it should be exported as. ### Sync - Synchronise files Reads files in the `.snose` index file and synchronises them with Simplenote. python snose.py --username=<me@email.com> --password=<mypassword> --sync You can pass the optional `--hanky` flag at the same time to perform a dry run; although the dry run can't indicate when merging will occur, only the ultimate direction of the update. python snose.py --username=<me@email.com> --password=<mypassword> --sync --hanky ### Snot - List files available for synchronisation with SNose Lists all files on Simplenote tagged "snose": python snose.py --username=<me@email.com> --password=<mypassword> --snot I could do with making this also list what is currently being synchronised based on the index. To make this most useful I suggest including the name of the file as a comment in the first line of the file. It's pretty slow. ### Blow - Rollback to the previous version of a note (Yeah, the command names are getting a bit rubbish now) Rolls back a note both locally and remotely to the previous version. python snose.py --username=<me@email.com> --password=<mypassword> --blow=<key> The `blow` command requires Simplenote.py to be at [this commit](https://github.com/mrtazz/simplenote.py/commit/50e3de947b70fa5d9a7faee004ae20b169a1547d) at least. ## How it works It's really quite simple (after all, I've done it), basically it creates a `.snose` file in the current directory that is json formatted. This is basically a Python dictionary that maps a filename (from the current directory) to a simplenote note (via the key) and also includes other simplenote data such as the modification date, version number and sync number (so it can figure out how to sync). It then just implements the Simplenote recommendation from the api: 1. Iterates through each file stored in the `.snose` index. 2. First of all looks for local modifications (compares modification date of the file with what is stored in the index). 3. Then attempts to update the remote version on Simplenote, but will merge the content if the remote has also changed. If merging occurs both the local and remote are updated. 4. Then checks for remote updates by comparing version numbers and updates local copies if necessary. ## To Do - <s>Files in subdirectories, what happens there? I've just assumed all files in same directory as index</s> They work just fine! However, robust cross-platform support would be nice to handle/interpret file path differences between platforms. - <s>Using tags to contain filename: "filename:pants.txt" Some potential character limitations though? But an interesting idea for meta data.</s> - I went for pulling it from a commented line in the file instead. - Add ability to "snort" multiple files - List files currently being synchronised (read the .snose index). The `--snot` lists files tagged *snose* on Simplenote and the two might not necessarily be the same (i.e you've chose to sync some files on one machine and a different set on another). - Write updated index file once after sync, instead of writing for each file change (although writing per file does have it's advantage from an error handling point of view) |
Changes to snose.py.
1 2 3 | #!/usr/bin/python #snose - Simplenote Object Synchronisation (Explicit) | | > | > | | | | | | | | > | | | | | | | | | | | | | > > > | | > > > | | | | | | | | | | | | | | < < < < < < | | | < | | < < < | | | | | | | | | < < < > < < < < < | | < < < < < | | < | < < < < | < | | < < | < < < | < < < < < | | < | < < < | | > > > > | | < | < | > | > > > > > > | < < < | < < < | | | | | | | | | < | | > | > | | | | | | | | | | | | < < < < | < > | < < | | < | | | | | | | | | | | | | | | | < | | < < < < < < | | | | | | | | | | | | | < < | < < < | > | | | | | | < < < < < | | | | | | | | | < | | > > > > > > > > > > > > > > > > > > > > > | > > > > > | > | | < < < | | > > > | | | | | | | | > > | | > > | < < | | | | | | | > > | > > | | > | > | > > > | < | > > | | | | | | | | | | | | > > > > | | > > | > > > | > > > > | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 | #!/usr/bin/python #snose - Simplenote Object Synchronisation (Explicit) import sys import json import simplenote #Need to install this import os.path, time from optparse import OptionParser import netrc import re def main(): parser = OptionParser() parser.add_option("--snort", action="store_true", default=False, help="Import a new file to Simplenote") parser.add_option("--sniff", action="store", nargs=1, type="string", help="Link a file with an already existing note in Simplenote", metavar="<key>") parser.add_option("--sneeze", action="store", nargs=1, type="string", help="Export an existing file from Simplenote", metavar="<key>") parser.add_option("--blow", action="store", type="string", help="Roll back note key to previous version", metavar="<key>") parser.add_option("--sync", help="Sync files in index", default=False, action='store_true') parser.add_option("--hanky", help="Use with --sync to perform a dry run", default=False, action='store_true') parser.add_option("--snot", help="List notes available for export (tagged snose)", default=False, action='store_true') parser.add_option("--file", help="Filename for snort, sniff, sneeze", default=None, action='store') parser.add_option("--username", action="store", type="string", help="Your Simplenote email address") parser.add_option("--password", action="store", type="string", help="Your Simplenote password") (options, args) = parser.parse_args() if not options.username or not options.password: #Check to see if stored somewhere try: options.username = netrc.netrc().authenticators("simple-note.appspot.com")[0] options.password = netrc.netrc().authenticators("simple-note.appspot.com")[2] except IOError as e: print('Username and password must be supplied or exist .netrc file under domain of simple-note.appspot.com') sys.exit() snclient = simplenote.Simplenote(options.username, options.password) if options.snort: if options.file is None: print('--file required') sys.exit() snort(snclient, options.file) elif options.sniff: if options.file is None: print('--file required') sys.exit() sniff(snclient, options.sniff, options.file) elif options.sneeze: sneeze(snclient, options.sneeze, options.file) elif options.blow: blow(snclient, options.blow) elif options.snot: snot(snclient) elif options.sync and options.hanky: sync(snclient, True) elif options.sync: sync(snclient) else: print('No options supplied') def snort(snclient, filename): snose = load_or_new() #Add new file to Simplenote #Need to get file contents content = snread(filename) if content: try: returned = snclient.add_note({"content": content, "tags": ["snose"]}) print("Imported %s into Simplenote with key %s" % (filename, returned[0]['key'])) except IOError as e: print("Failed to add note to Simplenote") print(e) else: #Add mapping snose[filename] = snobject(returned[0], filename) write_index(snose, "But note was successfully imported to Simplenote with key %s. Try sniffing the file") def sniff(snclient, key, filename): #How to ensure remote gets or has snose tag? # Add a new mapping only snose = load_or_new() #Get details about current Simplenote file remote = snremote(snclient, key) if remote: #Add mapping snose[filename] = snobject(remote[0], filename) write_index(snose) def sneeze(snclient, key, filename): #place an existing note in current directory snose = load_or_new() #Get remote note remote = snremote(snclient, key) if remote: #Write file #If no filename supplied try to figure out from first three lines of file itself if filename is None: firstlines = remote[0]['content'].splitlines()[:3] for line in firstlines: try: filename = re.search(r'file:(\S+)', line).group(1) except IndexError: pass except AttributeError: pass if filename is None: print("Failed to identify filename within note, please provide on command line") sys.exit() filename = os.path.expanduser(filename) ok = snwrite(filename, remote) if ok: #Update index snose[filename] = snobject(remote[0], filename) write_index(snose, "But note was created locally. Try sniffing the file to add it to the index.") def blow(snclient, key): #With given key from .snose file, roll back to the previous version #1) Check exists in .snose index #2) Get previous version of remote #3) Write it out locally #4) Use that to update remote #5) Update index file with results #1) Check exists in .snose index try: snose = load_or_new() #Need to get filename of note, loop through, performance should be fine as .snose likely to be small sitems = snitems(snose) filename = [name for name, local in sitems if local['key'] == key][0] print("Attempting to rollback file %s" % filename) except IndexError as e: print("Note doesn't exist in local .snose index") else: #2) Get previous version of remote try: #fetch once to know version remote = snclient.get_note(key) rollback = snclient.get_note(key, remote[0]['version']-1) except IOError as e: print("Failed to fetch previous version") else: ok = snwrite(filename, rollback, msg="Failed to rollback local copy of that note") if ok: print("Rolled back local copy of that note") #Since rollback doesn't include full meta data, update remote accordingly try: del remote[0]['version'] except KeyError: pass finally: #Set modified date sysmodifydate = float(os.path.getmtime(filename)) remote[0]['modifydate'] = sysmodifydate remote[0]['content'] = rollback[0]['content'] #4) Use that to update remote try: returned = snclient.update_note(remote[0]) print("Rolled back remote version") except IOError as e: print("Failed to roll back remote version") else: #Get returned metadata snose[filename]['version'] = returned[0]['version'] snose[filename]['modifydate'] = sysmodifydate write_index(snose, "Try running a sync to get index corrected.") def snot(snclient): #List simplenote notes tagged with "snose" notelist = snclient.get_note_list() #That gets list of keys. Then need to iterate through and get first line of text. #This is going to be slow. print("Key: \tNote") for note in notelist[0]: if ("snose" in note['tags']) & (int(note['deleted']) != 1): #get note itself remote = snclient.get_note(note['key']) print(remote[0]['key'] + " \t" + remote[0]['content'].splitlines()[0]) def sync(snclient, dry=False): #Need to read in mappings and sync those notes. dryremotes = [] snose = load_or_new() #Need to iterate through list. sitems = snitems(snose) for name, local in sitems: #First of all check for local modifications sysmodifydate = float(os.path.getmtime(name)) if sysmodifydate > float(local['modifydate']): #ensure full timestamp if not dry: #Update remote content = snread(name, "Skipping synchronisation for this note") if content: try: returned = snclient.update_note(snobject(local, name, tags=['snose'], content=content)) print("Updated remote version of %s" % name) except IOError as e: print("Failed to update remote verison of local note %s" % name) else: #Get returned metadata snose[name]['version'] = returned[0]['version'] snose[name]['modifydate'] = sysmodifydate #Use local value to avoid differences in accuracy (decimal places. etc) between local and remote timestamps #Update local file if merged content if 'content' in returned[0]: ok = snwrite(name, returned, msg="Failed to merge content locally for %s, therefore skipping updating the index for this note" % name) if ok: print("Merged local content for %s" % name) #Override the returned value? As otherwise next sync will immediately update the remote version for no reason. snose[name]['modifydate'] = os.path.getmtime(name) #Update the index file write_index(snose, "But remote and local copy of the file itself have been updated.") elif dry: print("Updated remote version of %s" % name) #For dry run, collect list of "updated remotes" to ignore in local updates dryremotes.append(name) #Fetch details from Simplenote remote = snremote(snclient, local['key'], "Skipping synchronisation for this file") if remote: if remote[0]['version'] > local['version']: if not dry: ok = snwrite(name, remote, msg="Failed to update local note %s with remote content. Will not update the .snose index file for this file" % name) if ok: print("Updated local version of %s" % name) #Also update .snose index snose[name]['version'] = remote[0]['version'] snose[name]['modifydate'] = os.path.getmtime(name) #As if set remote modify date, local file will immediately appear 'modified' write_index(snose, "But local copy of the file %s has been updated with remote changes" % name) elif (dry and (not (name in dryremotes))): print("Updated local version of %s" % name) def load_or_new(): try: with open('.snose', 'r') as f: snose = json.load(f) except IOError as e: #Doesn't exist so create new snose = {} return snose def write_index(snose, msg=None): try: with open('.snose', 'w') as f: json.dump(snose, f, indent=2) except IOError as e: print("Failed to update index") if msg: print(msg) def snobject(returned, filename, tags=None, content=None): sno = {'key': returned['key'], 'version': returned['version'], 'modifydate': float(os.path.getmtime(filename)) } if tags: sno['tags'] = tags if content: sno['content'] = content return sno def snitems(snose): if sys.version_info < (3, 0): sitems = snose.iteritems() else: sitems = snose.items() return sitems def snwrite(name, remote, msg=None): try: if sys.version_info < (3, 0): with open(name, 'w') as f: f.write(remote[0]['content'].encode("utf-8")) else: with open(name, 'w', encoding="utf-8") as f: f.write(remote[0]['content']) except IOError as e: if msg: print(msg) print("Failed to create local copy of that note") print(e) else: return True def snread(filename, msg=None): try: with open(filename, 'r') as f: content = f.read() except IOError as e: print("Failed to read file %s" % filename) if msg: print(msg) else: return content def snremote(snclient, key, msg=None): try: remote = snclient.get_note(key) #What if can't be found, need to abort... except IOError as e: print("Failed to find that note on Simplenote") print(e) if msg: print(msg) else: return remote main() |