Metadata-Version: 2.1
Name: configini
Version: 0.3
Summary: Small package to easily parse an .ini file.
Home-page: https://github.com/Spider-Frog/configini
Author: SpiderFrog
Author-email: germanspiderfrog@gmail.com
License: UNKNOWN
Description: # configini
        Small package to easily parse an .ini file.
        
        ## Read values
        #### config.ini
        ```ini
        [chapter]
        key=hello world
        ```
        Import the configini module into your _config.py_ file.
        Then read the _config.ini_ file, 
        and fetch the values from the configini module.
        #### config.py:
        ```python
        import configini
        
        # Read the config.ini file.
        configini.read('config.ini')
        
        class Config:
            # Set value1 to [chapter] => key
            value = configini.get('chapter', 'key')
        
        ```
        Then you can use your config variables like this:
        #### example.py:
        ```python
        # Import the config file
        from config import Config
        
        # Do whatever you want with it.
        some_variable = Config.value1
        ```
        
        ## Cast data types
        To cast values to different data types. you can set the parameter _date_type_
        #### config.ini:
        ```ini
        [chapter]
        number=2
        decimal=6.2
        boolean=true
        list=["A", "B", "C"]
        ```
        
        #### config.py:
        ```python
        import configini
        
        class Config:
            integer_value = configini.get('chapter', 'key', data_type=int)
            float_value = configini.get('chapter', 'key', data_type=float)
            boolean_value = configini.get('chapter', 'key', data_type=bool)
            list_value = configini.get('chapter', 'key', data_type=list)
        ```
        
        **Note:** If _data_type_ is set to _bool_, only empty values, '0' and 'false' will be cast to False.\
        **Note:** Only use double quote for strings inside list, the json.loads() method is used for parsing to list.
        
        ## default values
        Default values will be used when the value inside the configurations file is empty.
        You can change the default value by passing the _default_ parameter.
        ```python
        import configini
        
        class Config:
            value = configini.get('chapter', 'key', default='Hello world')
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
