Final paths, LICENSE, README

Author: bencromwell

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Ben Cromwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,71 @@
+# sshush
+
+Takes a YAML defined set of SSH configs and produces an SSH config file from it.
+
+Defaults to `~/.ssh/config.yml` for the source and `~/.ssh/config` for the destination.
+
+#### Premise
+
+I wanted a way to manage my SSH config file that allowed me to define an inheritance based structure. This allows you to group hosts together, apply common options and be able to override the options if needs be. For example, maybe you have everything in DigitalOcean on a particular port with a particular user and SSH key, but everything in AWS is different. Or they share ports but not keys. 
+
+#### Globals
+
+Options that apply to the catch-all `Host *`.
+
+#### Defaults
+
+Basic options such as a default User or IdentityFile. Can be overridden by group or individual host entries.
+
+#### Example
+
+Example config demonstrating the use of the global and default options:
+
+```yaml
+
+---
+global:
+  UseRoaming: "no"
+
+default:
+  User: ben
+  IdentityFile: ~/.ssh/id_rsa
+
+web_servers:
+  Port: 2201
+  IdentityFile: ~/.ssh/digital_ocean
+  Hosts:
+    projects-do-1:
+      HostName: projects-do-1.example.com
+    projects-do-2:
+      HostName: projects-do-2.example.com
+    projects-aws:
+      HostName: projects-aws.example.com
+      IdentityFile: ~/.ssh/aws
+
+raspberry_pis:
+  User: pi
+  Hosts:
+    pi1:
+      HostName: 192.168.0.107
+    pi2:
+      HostName: 192.168.0.108
+
+local:
+  Hosts:
+    router:
+      HostName: 192.168.0.1
+      User: root
+    kodi:
+      HostName: 192.168.0.200
+
+work:
+  User: bcromwell
+  Hosts:
+    workpc:
+      HostName: 10.0.0.80
+    gitlab:
+      HostName: 10.0.0.30
+    jenkins:
+      HostName: 10.0.0.20
+
+```

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup
 
 setup(name='sshush',
-      version='0.1',
+      version='1.0.0',
       description='SSH Config management tool',
       url='http://github.com/bencromwell/sshush',
       author='Ben Cromwell',

sshush/command_line.py

@@ -1,14 +1,19 @@
 import argparse
 from os.path import expanduser
-from sshush.parser import read_file, process_yaml
+from sshush.sshush import read_file, process_yaml
 
 
 def main():
-    default_path = '{home}/.ssh/test-config'.format(home=expanduser('~'))
+    default_path = '{home}/.ssh/config'.format(home=expanduser('~'))
+    default_yaml_path = '{home}/.ssh/config.yml'.format(home=expanduser('~'))
 
     arg_parser = argparse.ArgumentParser()
 
-    arg_parser.add_argument('yaml_file', help='Source YAML')
+    arg_parser.add_argument(
+        '--source', '-s',
+        help='Path to source YAML file if it differs from {}'.format(default_yaml_path),
+        default=default_yaml_path
+    )
 
     arg_parser.add_argument(
         '--path', '-p',
@@ -20,10 +25,10 @@ def main():
 
     print('sshush running with path "{path}" and source YAML "{yaml}"'.format(
         path=args.path,
-        yaml=args.yaml_file
+        yaml=args.source
     ))
 
-    yaml_obj = read_file(args.yaml_file)
+    yaml_obj = read_file(args.source)
     config_file_contents = process_yaml(yaml_obj)
 
     try:

sshush/parser.py sshush/sshush.pysshush/parser.py renamed to sshush/sshush.py

@@ -23,7 +23,7 @@ def process_yaml(ssh_config_yaml):
         settings = {**defaults, **item}
 
         for reference, host_details in hosts.items():
-            output.append(reference)
+            output.append('Host {}'.format(reference))
             host_settings = {**settings, **host_details}
 
             for k, v in host_settings.items():