Skip to content

Commit 9d2cd06

Browse files
Merge pull request #6 from BrunoSilvaAndrade/develop
Develop
2 parents 6381da5 + 406d8cd commit 9d2cd06

2 files changed

Lines changed: 18 additions & 12 deletions

File tree

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,46 @@
1-
# python-config-parser
1+
Python-config-parser
2+
===
23
This project was created to give you the possibility
34
of creating runtime configuration objects using json or yaml files.
45

56
MAIN FEATURES
6-
---------------------------
7+
===
8+
---
79
* Declarative configurations without using .ini files
810
* Access OOP or subscriptable, which means that you can iterate the config object items
911
* Runtime validation using [schema](https://github.com/keleshev/schema)
1012
* Automatic environment variables interpolation
1113
* Automatic parser selecting by config file extension
1214

1315
HOW TO INSTALL
14-
---------------------------
16+
===
17+
---
1518
Use pip to install it.
1619

1720
```shell
1821
pip install python-config-parser
1922
```
2023

2124
HOW TO USE
22-
---------------------------
23-
First of all the config file will look for default config files if you do not pass your own config file for this.
25+
===
26+
---
27+
First of all the config file will look for default config files if you do not pass your own config file for this.
2428

25-
The default config directory is ./config(if you do not pass the config directory of your preference) assuming your current directory.
29+
The default config directory is ./config(if you do not pass the config directory of your preference) assuming your current directory.
2630

27-
The default config files names are -> (config.json, config.yaml, config.yml)
31+
The default config files names are -> (config.json, config.yaml, config.yml)
2832

2933

3034

3135

3236
The Schema validation.
37+
---
3338

34-
You may use or not schema validation, if you want to use it, it will validate your whole config object before returning it.
39+
You may use or not schema validation, if you want to use it, it will validate your whole config object before returning it.
3540

36-
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.
41+
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.
3742

38-
How to use schema
43+
How to use schema
3944

4045
```python
4146
from schema import Use, And
@@ -155,6 +160,7 @@ Config.set_hold_an_instance(False)
155160

156161

157162
CONTRIBUTE
158-
----------
163+
---
164+
---
159165

160166
Fork https://github.com/BrunoSilvaAndrade/python-config-parser/ , create commit and pull request to ``develop``.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name='python-config-parser',
8-
version='2.2.0',
8+
version='2.2.1',
99
author='Bruno Silva de Andrade',
1010
author_email='brunojf.andrade@gmail.com',
1111
description='Project created to given the possibility of create dynamics config files',

0 commit comments

Comments
 (0)