Metadata-Version: 2.1
Name: configParsePy
Version: 0.0.4
Summary: A tiny Configuration File Parser for Python Projects. Currently Supports JSON files only.
Home-page: https://github.com/TanmoySG/configPy
Author: Tanmoy Sen Gupta
Author-email: tanmoysps@gmail.com
License: MIT
Keywords: imports,configurations,python,project
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# configPy [ 🏗 Under Construction ]

A tiny Configuration File Parser for Python Projects. Currently Supports JSON files only. 

## Installation

Will be Publised soon on `PyPi`. Installation instruction and documentation will be updated soon.

## Usage 

Use configPy to get your configurations imported to your python code from JSON File.


### `JSONConfigParser` - for JSON Configuration Files

Import the `JSONConfigParser` object from configPy module.
```
from configPy import JSONConfigParser
```

Initiate the `JSONConfigParser` by passing the JSON config file. Use `getConfigurations()` method to get the Configuration. `The getConfigurations()` method returns the configurations as a Dictionary.
```
importedConfigs = JSONConfigParser(configFilePath="./sampleConfig.json").getConfigurations()
```

Use the configurations as a `dict` object.
```
print("Module Name: ", importedConfigs["module_name"])
print("Purpose: ", importedConfigs["purpose"])
```

The whole code for the above example can be found [here](./examples/sample_jsonConfig.py).

## Examples

Usage Samples can be found in the [examples directory](./examples)


