Merge pull request #4 from BrunoSilvaAndrade/develop

Develop

Author: BrunoSilvaAndrade

.gitignore

@@ -1,5 +1,5 @@
 .idea/
-python_json_config_parser.egg-info/
+python_config_parser.egg-info/
 venv
 dist
 build

README.md

@@ -8,6 +8,7 @@ MAIN FEATURES
 * Access OOP or subscriptable, which means that you can iterate the config object items
 * Runtime validation using [schema](https://github.com/keleshev/schema)
 * Automatic environment variables interpolation
+* Automatic parser selecting by config file extension
 
 HOW TO INSTALL
 ---------------------------
@@ -19,14 +20,22 @@ pip install python-config-parser
 
 HOW TO USE
 ---------------------------
+    First of all the config file will look for default config files if you do not pass your own config file for this.
+
+    The default config directory is ./config(if you do not pass the config directory of your preference) assuming your current directory.
+
+    The default config files names are -> (config.json, config.yaml, config.yml)
+
+
+
 
 The Schema validation.
 
-You may use or not schema validation, if you want to use it, it will validate your whole config object before returning it.
+    You may use or not schema validation, if you want to use it, it will validate your whole config object before returning it.
 
-If you don't want to use it, it won't validate the config object before returning that, and it may generate runtime access inconsistencies.
+    If you don't want to use it, it won't validate the config object before returning that, and it may generate runtime access inconsistencies.
 
-How to use schema
+    How to use schema
 
 ```python
 from schema import Use, And
@@ -61,6 +70,29 @@ core:
   - ip: 192.168.0.11
     timeout: 100
 ```
+This config file as a json would be something like:
+
+```json
+{
+  "core": {
+    "random_env_variable": "${RANDOM_ENV_VARIABLE}",
+    "logging": {
+      "format": "[%(asctime)s][%(levelname)s]: %(message)s",
+      "date_fmt": "%d-%b-%y %H:%M:%S"
+    },
+    "allowed_clients": [
+      {
+        "ip": "192.168.0.10",
+        "timeout": 60
+      },
+      {
+        "ip": "192.168.0.11",
+        "timeout": 100
+      }
+    ]
+  }
+}
+```
 
 The instance of Config Class:
 ```python

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name='python-config-parser',
-    version='2.1.0',
+    version='2.1.1',
     author='Bruno Silva de Andrade',
     author_email='brunojf.andrade@gmail.com',
     description='Project created to given the possibility of create dynamics config files',