Updated README.md

Author: shadowy-pycoder

README.md

@@ -0,0 +1,57 @@
+# paya - Simple tool that converts YAML configuration files to Python objects
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+
+## Installation
+
+```shell
+pip install pyya
+```
+
+## Usage
+
+Create YAML configuration files for your project:
+
+
+```yaml
+# default.config.yaml - this file usually goes to version control system
+database:   
+    host: localhost
+    port: 5432
+    username: postgres
+    password: postgres
+```
+
+```yaml
+# config.yaml - this file for production usage
+database:   
+    username: username
+    password: password
+```
+
+Import configuration files in your Python code with pyya:
+
+```python
+import json
+
+from pyya import init_config
+
+config = init_config(
+    'config.yaml', 'default.config.yaml', 
+    convert_keys_to_snake_case = False,
+    raise_error_non_identifiers = False)
+print(json.dumps(config.database))
+
+# Output:
+# {"host": "localhost", "port": 5432, "username": "username", "password": "password"}
+
+```
+
+As you can see, pyya automatically merges default config file with production config file.
+
+Under the hood `pyya` uses [munch](https://pypi.org/project/munch/) library to create attribute-stylish dictionaries.
+
+`paya` automatically adds underscore prefix to Python keywords and can be configured to convert `camelCase` or `PascalCase` keys to snake_case. 
+
+If `raise_error_non_identifiers` is True, `pyya` will raise error if section name is not valid Python identifier.

pyya/__init__.py

@@ -23,7 +23,7 @@ def init_config(
     default_config: Union[str, Path] = 'default.config.yaml',
     *,
     convert_keys_to_snake_case: bool = False,
-    check_for_identifiers: bool = False,
+    raise_error_non_identifiers: bool = False,
 ) -> Munch:
     def _merge_configs(_raw_data: ConfigType, _default_raw_data: ConfigType) -> None:
         for section, entry in _default_raw_data.items():
@@ -39,11 +39,10 @@ def _sanitize_section(section: str) -> str:
         if convert_keys_to_snake_case:
             logger.warning(f'converting section `{section}` to snake case')
             section = to_snake(section)
-        if check_for_identifiers:
-            if not section.isidentifier():
-                err_msg = f'section `{section}` is not a valid identifier, aborting'
-                logger.error(err_msg)
-                raise PayaError(err_msg)
+        if raise_error_non_identifiers and not section.isidentifier():
+            err_msg = f'section `{section}` is not a valid identifier, aborting'
+            logger.error(err_msg)
+            raise PayaError(err_msg)
         if keyword.iskeyword(section):
             logger.warning(f'section `{section}` is a keyword, renaming to `_{section}`')
             section = f'_{section}'