jakob.scheid
00a5f08171
geändert: pyproject.toml geändert: src/config_parser/__init__.py gelöscht: src/config_parser/__main__.py geändert: src/config_parser/ini.py neue Datei: src/config_parser/parse/__init__.py geändert: src/config_parser/parse/ini.py geändert: src/config_parser/parse/json.py neue Datei: src/config_parser/serialize/__init__.py neue Datei: src/config_parser/serialize/ini.py neue Datei: src/config_parser/serialize/json.py neue Datei: tests/json/test_serializer.py
89 lines
1.8 KiB
Markdown
89 lines
1.8 KiB
Markdown
# config-parser
|
|
|
|
A library to parse configuration files.
|
|
|
|
## Installation
|
|
You can install the library using pip:
|
|
|
|
```bash
|
|
pip install config-parser --index-url https://jcloud-services.ddns.net/simple/
|
|
```
|
|
|
|
## Usage
|
|
Here are a few simple examples of how to use the `config-parser` library to read an configuration files:
|
|
|
|
### INI Configuration
|
|
```python
|
|
from config_parser.ini import INIConfiguration
|
|
|
|
with open('config.conf', 'r') as file:
|
|
config_content = file.read()
|
|
|
|
parsed = INIConfiguration.from_string(config_content)
|
|
print(dict(parsed))
|
|
```
|
|
|
|
If the configuration file content is:
|
|
```ini
|
|
global1=global value1
|
|
global2=global value2
|
|
|
|
[section1]
|
|
key1=value1
|
|
key2=value2
|
|
|
|
[section2]
|
|
hello=world
|
|
|
|
[section3]
|
|
key=value
|
|
```
|
|
|
|
the result will be `{'section1': {'key1': 'value1', 'key2': 'value2'}, 'section2': {'hello': 'world'}, 'section3': {'key': 'value'}}`
|
|
|
|
### JSON Configuration
|
|
```python
|
|
from config_parser.json import JSONConfiguration
|
|
|
|
with open('config.json', 'r') as file:
|
|
config_content = file.read()
|
|
|
|
parsed = JSONConfiguration.from_string(config_content)
|
|
print(dict(parsed))
|
|
```
|
|
|
|
If the configuration file content is:
|
|
```json
|
|
{
|
|
"section1": {
|
|
"key1": "value1",
|
|
"key2": "value2",
|
|
"number": 42,
|
|
"number2": 3.14,
|
|
"number3": -1,
|
|
"boolean": true,
|
|
"boolean2": false,
|
|
"null": null
|
|
},
|
|
"section2": {
|
|
"hello": "world"
|
|
},
|
|
"section3": {
|
|
"key": "value"
|
|
}
|
|
}
|
|
```
|
|
|
|
the result will be `{'section1': {'key1': 'value1', 'key2': 'value2', 'number': 42, 'number2': 3.14, 'number3': -1, 'boolean': True, 'boolean2': False, 'null': None}, 'section2': {'hello': 'world'}, 'section3': {'key': 'value'}}`
|
|
|
|
## Changelog
|
|
### Version 1.1.0
|
|
- JSON and INI serializer
|
|
|
|
### Version 1.0.0
|
|
- JSON parser
|
|
- better API
|
|
|
|
### Version 0.1.0
|
|
- First release
|
|
- INI parser |