Update docs about push and pull

Author: OrkoHunter

README.rst

@@ -30,9 +30,8 @@ Features
 
 - Save a new command with a brief description
 - Search the saved commands using powerful patterns
-- ~Save the commands on the remote on the server~
-- ~Use ``keep push`` and ``keep pull`` to sync the commands between all your computers.~
-
+- Save the commands as a secret GitHub gist
+- Use ``keep push`` and ``keep pull`` to sync the commands between GitHub gist and other computers.
 
 **ProTip : Save the commands you usually forget in ssh sessions and sync it with your local machine.**
 
@@ -64,14 +63,17 @@ Usage
       --help         Show this message and exit.
 
     Commands:
-      grep      Searches for a saved command.
-      init      Initializes the CLI.
-      list      Show the saved commands.
-      new       Saves a new command.
-      rm        Deletes a saved command.
-      run       Executes a saved command.
-      update    Check for an update of Keep.
-
+      edit          Edit a saved command.
+      github_token  Register a GitHub Token to use GitHub Gists as a backup.
+      grep          Searches for a saved command.
+      init          Initializes the CLI.
+      list          Shows the saved commands.
+      new           Saves a new command.
+      pull          Pull commands from saved GitHub gist.
+      push          Push commands to a secret GitHub gist.
+      rm            Deletes a saved command.
+      run           Executes a saved command.
+      update        Check for an update of Keep.
 
 `See the detailed usage and tutorial. <https://github.com/OrkoHunter/keep/blob/master/tutorial.md>`_
 

keep/commands/cmd_github_token.py

@@ -20,9 +20,9 @@ def cli(ctx):
                          abort=True):
             os.remove(dir_path)
 
-    token = click.prompt('Create a GitHub token with permission to Gists and paste here : ')
+    token = click.prompt('Create a GitHub token with permission to Gists and paste here ')
     gist_id = existing_token.get('gist') if existing_token else None
-    prompt_str = 'If you already have a GitHub gist created by keep, paste the Gist ID here, or else press Enter : '
+    prompt_str = 'If you already have a GitHub gist created by keep, paste the Gist ID here, or else press Enter '
     new_gist_id = click.prompt(prompt_str, default='', show_default=False)
 
     if new_gist_id:
@@ -37,3 +37,6 @@ def cli(ctx):
 
     with open(dir_path, 'w') as f:
         json.dump({'token': token, 'gist': gist_id}, f)
+
+    click.echo("Done! Gist URL - https://gist.github.com/" + gist_id)
+    click.echo("You can now use `keep push` or `keep pull`")

tutorial.md

@@ -1,19 +1,13 @@
-Note: Push, Pull and Register are disabled. Sync will be re-enabled using github gist.
-
 # Tutorial
 
  - Initialize Keep with `keep init`. This creates a `.keep` directory in your home folder.
- - You are then asked to register.
-  - It asks for your Email because that is unique to you. It is just another username and thus you can input anything
-     unique to you.
-  - You can choose to not register this time and later start the process by using `keep register`.
-  - You can use Keep CLI without registering if you do not intend to use the server for storing or fetching your commands.
- - It generates a 255 bit password for you. It is then stored inside your `~/.keep/.credentials` file.
  - Start saving commands using `keep new`.
  - Once you have saved couple of commands, start using `keep grep`.
   - This is not exactly similar to `keep list | grep` as `keep grep` search is more powerful.
- - Now it's time to store the commands on the server. Use `keep push`.
- - If you have got another computer, install `keep` on it. Do `keep init` and skip registration. Copy your `~/.keep/.credentials` over to that computer in the same location.
+ - Use `keep github_token` to register a GitHub token for gist as backup. It is then stored inside your `~/.keep/.credentials` file.
+ - Now it's time to store the commands on github gists. Use `keep push`.
+  - **NOTE: keep creates a secret GitHub gist. They can still be accessed using the direct URL of the gist.**
+ - If you have got another computer, install `keep` on it. Do `keep init`. Copy your `~/.keep/.credentials` over to that computer in the same location, or follow `keep github_token`.
  - Do `keep pull` to retrieve all the saved commands.
  - Have fun !
 
@@ -27,7 +21,7 @@ Note: Push, Pull and Register are disabled. Sync will be re-enabled using github
   <dd>This is used to search for saved commands.<br><br>Argument passed to <code>keep grep</code> is interpreted in two ways. First, it is interpreted as a regular expression and if it matches any command or description, then the search is displayed. If this fails, the argument is then splitted and the individule words of the argument are searched in the commands and the descriptions. If all the splits of the argument are found in a command or a discription, the result is displayed.</dd>
 
   <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_init.py">init</a></dt>
-  <dd>Initializes the CLI.<br><br>The CLI is supposed to be installed if there exists a <code>.keep</code> direcotry in the home directory. Once installed, this command is not supposed if the user intends to reset the local database of keep.</dd>
+  <dd>Initializes the CLI.<br><br>The CLI is supposed to be installed if there exists a <code>.keep</code> direcotry in the home directory. Once installed, this command is not supposed to be used unless the user intends to reset the local database of keep.</dd>
 
   <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_list.py">list</a></dt>
   <dd>Shows the saved commands.<br><br>Keep uses tabulate library to show the result. If the command length is long, the table may look like in need of wrapping. But increasing the terminal width works for the best.</dd>
@@ -36,13 +30,13 @@ Note: Push, Pull and Register are disabled. Sync will be re-enabled using github
   <dd>Saves new command locally.<br><br>If the command already exists, it updates the previously stored description.</dd>
 
   <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_pull.py">pull</a></dt>
-  <dd>Updates the local commands with remote.<br><br>Once registered, this command fetches your database saved on the remote and updates the local storage.</dd>
+  <dd>Updates the local commands with saved GitHub gist.<br><br>Once registered, this command fetches your database saved on the remote (GitHub gist) and updates the local storage.</dd>
 
   <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_push.py">push</a></dt>
-  <dd>Updates remote with local commands.<br><br>This command updates the remote database with the local storage. Consider using this command before storing a new command on some other computer without pulling the latest changes.</dd>
+  <dd>Updates GitHub gist with local commands.<br><br>This command updates the remote (GitHub gist) with the local storage. Consider using this command before storing a new command on some other computer without pulling the latest changes.</dd>
 
-  <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_register.py">register</a></dt>
-  <dd>Create remote for the user.<br><br>If not registered while <code>keep init</code>, this command can be used for the same purpose in future.</dd>
+  <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_github_token.py">github_token</a></dt>
+  <dd>Register a GitHub token.<br><br>Register a GitHub token to use push and pull commands with a GitHub gist.</dd>
 
   <dt><a href="https://github.com/OrkoHunter/keep/blob/master/keep/commands/cmd_rm.py">rm</a></dt>
   <dd>Deletes a command.<br><br>Input the exact command you have saved and this removes it from the local storage. If the user uses <code>push</code> after removing any command, the same will be overwritten on the remote.</dd>