v1.0 release

Author: aviaryan

.gitignore

@@ -6,3 +6,4 @@ __pycache__
 .DS_Store
 FLAG_FILE
 settings.json
+.release/

README.markdown

@@ -1,25 +1,27 @@
-# Sublime Notebook
+<h1 align="center">
+	Sublime Notebook :memo:
+</h1> 
 
-**v0.9**
+**v1.0**
 
 Sublime Notebook is an attempt to use Sublime Text as a complete note taking application.
 
 > Blog post for v0.3.0 (no longer recommended) https://medium.com/aviaryan/b8d846c47905#.hy8alq2ip
 
 
-## Why did you build this?
+## Why did you build this? :thinking:
 
 I have been note-taking for as long as I started using computers. I use notes mostly for technical stuff, but these days I am using notes to record all kinds of information like journals, ideas, snippets etc. In my career, I have tried a number of note-taking tools like OneNote, Evernote, CintaNotes, SimpleNote, Cherrytree, Google Keep, etc. But I have never been satisfied with them mainly because - 
 
 1. I don't have any control over how or where my notes are stored. - What if the company closes or the developer stops building the product?
-2. Most of these services are paid or work on only certain Operating Systems. And even if they are truly free and cross-platform, they lack critical features like fast full notebook search or hierarchical organization. 
+2. Most of these services are paid or work on only certain Operating Systems. And even if they are truly free and cross-platform, they lack critical features like fast full notebook search or hierarchical organization.
 
-Because of these reasons, I had to lose my notes a number of times and was forced to start from scratch. This was frustrating, and finally, I decided to do something about it. 
+Because of these reasons, I had to lose my notes a number of times and was forced to start from scratch. This was frustrating, and finally, I decided to do something about it.
 
 The result is this project, a wrapper/idea that converts my favorite text editor, Sublime Text, to a feature-rich note-taking tool. Sure it might not be as polished as all those premium note-taking tools, but it works and that too in the way I want it to.
 
 
-## Features
+## Features :sunglasses:
 
 * Faaaast Search across all notes (thanks to Sublime Text)
 * Hierarchical organization and display of notes
@@ -29,6 +31,6 @@ The result is this project, a wrapper/idea that converts my favorite text editor
 * Markdown based markup and code syntax highlighting
 
 
-## Documentation
+## Documentation :yum:
 
-Find the docs in the [sublime_notebook/docs](sublime_notebook/docs) folder.
+Find the docs in the [sublime_notebook/docs](sublime_notebook/docs/README.markdown) folder.

sublime_notebook/__init__.py

@@ -1,2 +1,2 @@
 SETTINGS_PATH = 'sublime_notebook/settings.json'
-VERSION = 0.9
+VERSION = 1.0

sublime_notebook/cryptlib.py

@@ -3,6 +3,7 @@
 import re
 from getpass import getpass
 from .settings import Settings
+from .message import print_err
 
 
 EXTRA_STR = 'ENCo0D#DT{xTCh$cKe>'
@@ -74,7 +75,7 @@ def update_file(funcptr, flist, key):
         if newData is None:
             newData = data
             failed = True
-            print('Failed decrypting %s' % file)
+            print_err('Failed decrypting %s' % file)
         fptr.write(newData)
         fptr.close()
         # check if failed

sublime_notebook/docs/README.markdown

@@ -1,21 +1,21 @@
-# Documentation
+<a name="docs"></a>
+# Table of Contents
 
-## Table of Contents
-
-* [Requirements](#rq)
-* [Getting Started](#gs)
-* [Accessing your notes](#ac)
-* [Encrypting your notes](#en)
-* [Note taking features](#nt)
-* [Changing SublimeNotebook password](#cp)
-* [Customizing which folders are encrypted](#custen)
-* [Automatic git backups](#git)
-* [Setting up better Markdown highlighting in Sublime Text](#mdext)
-* [FAQ](#faq)
+:one: [Requirements](#rq)  
+:two: [Getting Started](#gs)  
+:three: [Accessing your notes](#ac)  
+:four: [Encrypting your notes](#en)  
+:five: [Note taking features](#nt)  
+:six: [Changing SublimeNotebook password](#cp)  
+:seven: [Customizing which folders are encrypted](#custen)  
+:eight: [Automatic git backups](#git)  
+:nine: [Setting up better Markdown highlighting in Sublime Text](#mdext)  
+:keycap_ten: [FAQ](#faq)  
 
 
 <a name="rq"></a>
-## Requirements
+## :one: Requirements
+:point_up_2: [[back to top](#docs)]
 
 The requirements for using this tool are as follows. Make sure to have them installed before proceeding to the next section.
 
@@ -25,7 +25,8 @@ The requirements for using this tool are as follows. Make sure to have them inst
 
 
 <a name="gs"></a>
-## Getting started
+## :two: Getting started
+:point_up_2: [[back to top](#docs)]
 
 The first step is downloading the release from https://github.com/aviaryan/SublimeNotebook/releases/latest.
 
@@ -37,21 +38,23 @@ Done! You can now create any number of notes in that folder. For hierarchy, you
 
 
 <a name="ac"></a>
-## Accessing your notes
+## :three: Accessing your notes
+:point_up_2: [[back to top](#docs)]
 
 To access your notes, we will use the Projects feature of Sublime Text.
 
 Open Sublime Text and click on "Open Project" in the Project menu.
 
-Browse for the `notebook.sublime-project` file in the folder you downloaded and open it. Now open the Sidebar (View -> Sidebar). You will see all your notes presented there with the hierarchy. 
+Browse for the `notebook.sublime-project` file in the folder you downloaded and open it. Now open the Sidebar (View -> Side Bar). You will see all your notes presented there with the hierarchy. 
 
 Whenever you want to open your Sublime Notebook, you can use the switch project shortcut (Cmd-Ctrl-P or Ctrl-Alt-P) and select `notebook.sublime-project` to switch to the Notebook project.
 
 ![Project Selector](https://user-images.githubusercontent.com/4047597/35473121-4556dd7a-03a1-11e8-8c3a-6e85592d5d5f.png)
 
 
 <a name="en"></a>
-## Encrypting your notes
+## :four: Encrypting your notes
+:point_up_2: [[back to top](#docs)]
 
 To encrypt or decrypt notes, you use the `manager.py` file located in the notebook root. It runs in Python 3 and requires no additional dependencies. 
 I recommend changing the first line of the file to point to your interpreter.
@@ -66,34 +69,42 @@ Then use `python manager.py` or `./manager.py` to run the script.
 
 When it runs for the first time, it will find the notes and ask you a password for encryption. 
 After getting the password, it will encrypt all non-public notes using that password. 
+
+![first time encryption](https://user-images.githubusercontent.com/4047597/35779481-b09abd92-09f3-11e8-8dee-accbf5a64581.png)
+
 In the subsequent runs, `manager.py` will work as an un-locker where it will ask password to decrypt the notes and then pause its execution. 
 Now you can view and edit your notes and then later on encrypt them again by entering 'e' in the prompt.
 
-![screen shot 2018-01-27 at 8 06 07 pm](https://user-images.githubusercontent.com/4047597/35472896-897a22a4-039d-11e8-9b1d-153c06bc203e.png)
+![second run](https://user-images.githubusercontent.com/4047597/35779488-dc1046cc-09f3-11e8-8773-ae66da8325c4.png)
 
 
 <a name="nt"></a>
-## Note taking features
+## :five: Note taking features
+:point_up_2: [[back to top](#docs)]
 
-To search through all your notes, use the Sublime Text’s search in project feature (Ctrl-Shift-F or Cmd-Shift-F).
+* To search through all your notes, use the Sublime Text’s search in project feature (Ctrl-Shift-F or Cmd-Shift-F).
 
-You can use the Sublime Text sidebar to view your notes in a hierarchical fashion.
+* You can use the Sublime Text sidebar to view your notes in a hierarchical fashion.
 
-Store the folder in Dropbox, Google Drive or Box to have it on all your computers (as well as secure a backup). 
+* Store the folder in Dropbox, Google Drive or Box to have it on all your computers (as well as secure a backup). 
 
-The Python 3 script uses no extra dependencies so you can run the script out-of-the-box on any system that has Python installed (popular Linux distros and Macs for example have it by default).
+* The Python 3 script uses no extra dependencies so you can run the script out-of-the-box on any system that has Python installed (popular Linux distros and Macs for example have it by default).
 
 
 <a name="cp"></a>
-## Changing SublimeNotebook password
+## :six: Changing SublimeNotebook password
+:point_up_2: [[back to top](#docs)]
 
 To change password of your Sublime Notebook, decrypt your existing notes using old `manager.py`, then exit the script in decrypted state (using "d").
 
 Then start `manager.py` again to re-encrypt your notes. This time you will be asked for a new password to encrypt your notes.
 
+![changing password](https://user-images.githubusercontent.com/4047597/35779512-310e70a4-09f4-11e8-9298-4243ae3fe04d.png)
+
 
 <a name="custen"></a>
-## Customizing which folders are encrypted
+## :seven: Customizing which folders are encrypted
+:point_up_2: [[back to top](#docs)]
 
 To customize which folders are encrypted, use the `settings.json` file in `sublime_notebook/` directory.
 
@@ -120,7 +131,8 @@ unintentional side-effects. `"is_encrypted": false` will be present in `settings
 
 
 <a name="git"></a>
-## Automatic git backups
+## :eight: Automatic git backups
+:point_up_2: [[back to top](#docs)]
 
 > This feature comes in handy for those who don't trust cloud data storage providers. You can even use this as a second backup for your data. I personally have auto git backups set up so that my notes are stored on both Dropbox and GitHub.
 
@@ -144,7 +156,7 @@ $ git remote add notebookbackup <GIT_REMOTE_URL>
 
 The git backup will run when you re-encrypt after decrypting the notebook.
 
-![git push](https://i.imgur.com/NFHZcv0.png)
+![git backup](https://user-images.githubusercontent.com/4047597/35779595-e2e04022-09f5-11e8-8fb6-2e808b29cdb6.png)
 
 To change how frequently git backup happens, change the `git_push_interval_minutes` value in `settings.json`.
 
@@ -158,7 +170,8 @@ To change how frequently git backup happens, change the `git_push_interval_minut
 
 
 <a name="mdext"></a>
-## Setting up better Markdown highlighting in Sublime Text
+## :nine: Setting up better Markdown highlighting in Sublime Text
+:point_up_2: [[back to top](#docs)]
 
 * Install the packages from here.
 
@@ -181,11 +194,13 @@ To change how frequently git backup happens, change the `git_push_interval_minut
 }
 ```
 
+![sublime monkai](https://camo.githubusercontent.com/e5112e65510eada23f8cdc306ba46bfe1043f201/68747470733a2f2f662e636c6f75642e6769746875622e636f6d2f6173736574732f3338333939342f3732363833332f30666465306431362d653133382d313165322d386533642d3864626663393132323465372e706e67)
+
 
 <a name="faq"></a>
-## FAQ
+## :keycap_ten: FAQ
+:point_up_2: [[back to top](#docs)]
 
-Only *.txt and *.md files are detected as notes.
+* Only *.txt and *.md files are detected as notes.
 
-You don't need to be in decrypted state to create a new note. Even when in encrypted state, you can create a note. 
-When manager.py starts decrypting the notes, this new file will be ignored and will be encrypted when it's time to encrypt. 
+* You don't need to be in decrypted state to create a new note. Even when in encrypted state, you can create a note. When `manager.py` starts decrypting the notes, this new file will be ignored and will be encrypted when it's time to encrypt. 

sublime_notebook/message.py

@@ -3,8 +3,13 @@
 """
 
 def print_info(msg):
-	print('\n[[ ' + msg + ' ]]\n')
+	if msg.find('\n') > -1:
+		print('\n' + msg)
+	else:
+		print('\n[[ ' + msg + ' ]]')
 
 def print_err(msg):
-	print('\n<< ' + msg + ' >>\n')
-	
+	if msg.find('\n') > -1:
+		print('\n' + msg)
+	else:
+		print('\n<< ' + msg + ' >>')

sublime_notebook/settings.py

@@ -105,7 +105,7 @@ def do_git_push(self):
 		# push to remote
 		print_info('Pushing to remote')
 		commit_msg = "auto backup " + str(mins)
-		out = check_output("git add . && git commit -m \"{}\" && git push notebookbackup master".format(commit_msg), 
+		out = check_output("git add -A && git commit -m \"{}\" && git push notebookbackup master".format(commit_msg), 
 			stderr=STDOUT, shell=True).decode()
 		print_info('GIT LOG:\n\n' + out)
 		self.json['last_git_push'] = mins

sublime_notebook/sublime_notebook.py

@@ -6,7 +6,7 @@
 import os
 from sys import exit
 from .cryptlib import get_file_list, encode, update_file, get_key, decode
-from .message import print_info
+from .message import print_info, print_err
 from .settings import Settings
 from sublime_notebook import SETTINGS_PATH
 
@@ -28,16 +28,22 @@ def main():
 	if not os.path.exists(SETTINGS_PATH):
 		# new case
 		# or decrypted state in power fail
-		print('Not encrypted, encrypting ....')
+		print_info('Not encrypted, encrypting ....')
 		# create settings
-		print_info('Created settings.json in sublime_notebook/')
+		print_info(
+			'Created settings.json in sublime_notebook/ directory.\n' +
+			'By default, only the "diary" directory is privated (encrypted), you can change this setting by editing settings.json.\n' +
+			'See the docs for more info.'
+		)
 		Settings._create_default_file()
 		# get password
+		print_info('Starting encryption process')
 		key = get_first_time_key()
 		update_file(encode, get_file_list(), key)
 		# update encryption status
 		sts = Settings()
 		sts.change_encrypted_status(True)
+		print_info('Sublime Notebook setup complete')
 	else:
 		# get settings
 		sts = Settings()
@@ -49,11 +55,11 @@ def main():
 		key = ''
 		if sts.get_encrypted_status():
 			# already encrypted
-			print('Encrypted. Enter key to unlock')
+			print_info('Encrypted. Enter key to unlock')
 			key = get_key()
 			failStatus = update_file(decode, get_file_list(), key)
 			if failStatus:
-				print('You entered wrong key. Fuck off!')
+				print_err('You entered wrong key. Please try again.')
 				exit(2)
 			# remove encryption status
 			sts.change_encrypted_status(False)
@@ -64,7 +70,7 @@ def main():
 		# now decrypted
 		ans = ''
 		while (True):
-			ans = input('Press "e" to encrypt\nPress "d" to stay decrypted\n> ')
+			ans = input('Press "e" to encrypt\nPress "d" to leave decrypted\n> ')
 			if ans == 'd' or ans == 'e':
 				if ans == 'e' and key == '':  # already decrypt case
 					key = get_first_time_key()
@@ -73,10 +79,12 @@ def main():
 			# encrypt
 			update_file(encode, get_file_list(), key)
 			sts.change_encrypted_status(True)
+			print_info('Notes encrypted')
 			# do git push
 			if sts.is_git_setup():
 				sts.do_git_push()
 		else:
 			# disable sublime notebook
 			# exit as-is
+			print_info('Notes have been left decrypted')
 			pass