master: add readme

Author: litcoderr

README.md

@@ -1,4 +1,87 @@
 # Importify
 Import and export your configuration like a boss !!
 
+## Installation
+Install using pypi distribution using following command.
+
+```
+pip install importify
+```
+
+## Quick Start
+Following is a recommended usage.
+
+1. Define configuration class.
+
+    - Must inherit Serializable
+    - Must call super constructor
+    - Serializable can consist json serializable types and nested Serializable object.
+    
+    example:
+    
+    ```python
+    from importify import Serializable
+
+
+    class Config(Serializable):
+        def __init__(self):
+            super(Config, self).__init__() 
+            self.use_gpu = True
+            self.batch_size = 32
+            self.model_config = ModelConfig()
+
+    class ModelConfig(Serializable):
+        def __init__(self):
+            super(ModelConfig, self).__init__()
+            self.hidden_dim = 256
+            self.output_dim = 128
+    ```
+
+2. Parse arguments
+
+    - Arguments are named the same as object variables.
+    - Nested variables are divided with dot symbol.
+    
+    (CODE)
+    
+    ```python
+    # Initialize Serializable inherited configuration class
+    config = Config()
+
+    # Parse
+    config.parse()
+    ```
+    
+    2-1. Parse command line arguments.
+
+        (BASH)
+        
+        ```
+        python -m your_module --use_gpu False
+        ```
+
+    2-2. Import from pre-exported configuration json file. Use ```--load_json``` option.
+    
+        (BASH)
+        
+        ```
+        python -m your_module --load_json PATH_TO_JSON_FILE
+        ```
+
+3. Export current settings to json.
+
+    example:
+    
+    ```python
+    config = Config()
+   
+    saved_status = config.export_json(path=PATH_TO_JSON_FILE)
+    ```
+   
 ## Usage
+Please refer to [https://github.com/litcoderr/importify/tree/master/examples](examples) code.
+
+## Contributions
+Please commit any issues or pull requests. Every bit of contributions are welcomed.
+If this ever goes viral, I'll make a legitimate template for issues and PRs. Thanks.
+

examples/__init__.py

@@ -1,7 +1,3 @@
-# temporary for test use
-import sys
-sys.path.insert(0, "/Users/litcoderr/project/importify")
-#####
 """
 This demonstrates how you can construct a serializable configuration object
 """

examples/exported.json

@@ -1 +1 @@
-{"is_awesome": true, "nested": {"is_legit": true, "double_nested": {"is_intuitive": true}}}
+{"is_awesome": true, "nested": {"is_legit": false, "double_nested": {"is_intuitive": true}}}

importify/interface.py

@@ -105,7 +105,6 @@ def strip(self, prefix: str = "") -> Dict[str, Any]:
         """ Strip arguments.
 
         Args:
-            instance: Parent Serializable instance
             prefix: Prefix string.
 
         Returns:
@@ -172,6 +171,7 @@ def parse(self):
         # Parse
         boolean_keys = []
         parser = argparse.ArgumentParser()
+        parser.add_argument('--load_json', type=str, default=None)
         for key, value in dicts.items():
             if type(value) == bool:
                 boolean_keys.append(key)
@@ -185,13 +185,18 @@ def parse(self):
                 parser.add_argument('--{key}'.format(key=key), type=type(value), default=value)
         args = vars(parser.parse_args())
 
-        # Deal with stringed boolean attributes
-        for key in boolean_keys:
-            if args[key] == "True":
-                args[key] = True
-            else:
-                args[key] = False
+        if args['load_json'] is None:
+            # Deal with stringed boolean attributes
+            for key in boolean_keys:
+                if args[key] == "True":
+                    args[key] = True
+                else:
+                    args[key] = False
 
-        # Unstrip and Update
-        for stripped_key, res in self.instance.unstrip(args).items():
-            setattr(res["reference"], res["key"], res["value"])
+            # Unstrip and Update
+            for stripped_key, res in self.instance.unstrip(args).items():
+                setattr(res["reference"], res["key"], res["value"])
+        else:
+            with open(args['load_json'], 'r') as file:
+                data = json.load(file)
+            self.instance.import_dict(data)