GitLocker: The Coding Marketplace

Description:

jsonconfigreader 1.3.1

Description
Utility that allows to read and parse json config files.
Possible to specify links to the default values in the config (See Usage
section).

Installation

Install python 3.6+
Ensure pip, setuptools, and wheel are installed and up to date

python -m pip install --upgrade pip setuptools wheel

Create virtual enviroment (make sure that is not part of the project)

python -m venv <ENV NAME>
or
python -m venv %path%\to\<ENV NAME>

Active virtual enviroment

%path%\to\<ENV NAME>\Script\activate

Install all project dependencies if needed

pip install -r requirements.txt

Install pandoc and pypandoc.
Instruction

pip install pypandoc

Usage
Example of the config file:
C:\User\test\qa_hotfix_config.json

{
"defaults": {
"dataBaseUrl": "http://db:5000"
},
"dataBase1": "<defaults.dataBaseUrl>",
"dataBase2": "<defaults.dataBaseUrl>"
}

Specify that lib in your project dependencies
Import
from jsonconfigparser.json_config_reader import JsonConfigReader
Create an instance of the class passing config folder path and
options

config_path = 'C:\User\test\qa_config.json'
json_config_reader = JsonConfigReader(config_path)
config = json_config_reader.get()
file_path = json_config_reader.get_config_file_path()
print(config['dataBase1'])
print(file_path)

>> http://db:5000
>> C:\User\test\qa_config.json

Uploading project to PyPi

Change version in setup.py
Upload changes to PyPi server

python setup.py sdist upload -r <Repository URL to the PyPi server>

Run unit tests (Example for Visual Studio)

From Visual Studio

Click Test -> Run -> All Test
View Test run in Test Explorer

From CLI

Navigate into project directory
python -m unittest

Generate docs and updating docs

Run easy_install -U sphinx
Navigate to docs folder
Run sphinx-quickstart
Follow
instruction