Initial commit

2026-03-12 19:34:25 +01:00
commit b00e5d9829
22 changed files with 2916 additions and 0 deletions
@@ -0,0 +1,88 @@
+# jcloud-config-parser
+
+A library to parse configuration files.
+
+## Installation
+You can install the library using pip:
+
+```bash
+pip install jcloud-config-parser --index-url https://repo.jcloud-services.ddns.net/simple/
+```
+
+## Usage
+Here are a few simple examples of how to use the `jcloud-config-parser` library to read an configuration files:
+
+### INI Configuration
+```python
+from jcloud_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 jcloud_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'}}`
+
+
+
+## Full documentation
+
+For the full documentation, see the Python docstrings.
+
+## Changelog
+
+### Version 0.1.0
+- Changed the name from `config-parser` to `jcloud-config-parser`