# zpp-config
## Informations
Librairie pour l'utilisation et la modification de fichier de configuration:<br>
- Charger un ou plusieurs paramètres
- Modifier un paramètre existant
- Ajout un paramètre ou une section
- Supprimer un paramètre ou une section
- Lister les sections disponibles
- Lister les paramètres et/ou sections désactivés
Prends en compte les paramètres commentés.<br>
Compatible avec les fichiers de configuration indentés.<br><br>
Traduit les paramètres pour les types str, int, float, bool, list, dict
### Prérequis
- Python 3
<br>
# Installation
```console
pip install zpp_config
```
# Utilisation
### Conseil d'importation du module
```python
from zpp_config import Config
```
<br>
### Exemple de fichier de config
```xml
[section]
value1 = key1
value2 = key2
value3 = key3
[section2]
value1 = key1
value2 = key2
value3 = key3
```
<br>
### Initialisaton d'un fichier de configuration
```python
c = Config("conf.ini")
```
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- separator: Définir le séparateur entre la clé et la valeur dans le fichier. (Par défaut: " = ")
>- escape_line: Définir le caractère utilisé pour commenter une valeur ou une section. (Par défaut: "#")
>- auto_create: Créer le fichier de configuration s'il n'existe pas. (Par défaut: "False")
>- read_only: Ouvrir le fichier de configuration en lecture seule. (Par défaut: "False")
<br>
### Chargement de paramètre
La fonction renvoie la valeur si un unique paramètre a été trouvé, sinon renvoie un dictionnaire avec les différentes valeurs trouvées (classé par section)
Renvoie un tableau vide si aucun paramètre n'a été trouvé
#### Chargement de tous les paramètres
```python
data = c.load()
```
#### Chargement d'une section du fichier
```python
data = c.load(section='section_name')
```
#### Chargement d'une valeur dans tout le fichier
```python
data = c.load(val='value_name')
```
#### Chargement d'une valeur dans une section spécifique
```python
data = c.load(val='value_name', section='section_name')
```
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- default: Pour initialiser une valeur par défaut si aucun résultat est trouvé
<br>
### Changement de paramètre
#### Changement d'une valeur dans tout le fichier
```python
c.change(val='value_name', key='key_value')
```
#### Changement d'une valeur dans une section spécifique
```python
c.change(val='value_name', key='key_value', section='section_name')
```
<br>
### Ajout de paramètre ou de section
Ajoute une section ou un paramètre dans le fichier de configuration.
Dans le cas de l'ajout d'un paramètre, rajoute la section si elle n'existe pas.
#### Ajout d'une section
```python
c.add(section='section_name')
```
#### Ajout d'un paramètre dans une section
```python
c.add(val='value_name', key='key_value', section='section_name')
```
> Si aucune section est défini, rajoute le paramètre en dehors des sections.
<br>
### Suppression de paramètre ou de section
#### Suppression d'une section
```python
c.delete(section='section_name')
```
#### Suppression d'un paramètre dans une section
```python
c.delete(val='value_name', section='section_name')
```
> Si aucune section est défini, recherche le paramètre en dehors des sections.
<br>
### Liste des paramètres non pris en compte
Retourne la liste des paramètres qui sont non pris en compte dans le fichier de configuration.
```python
data = c.disabled_line()
```
> Possibilité de préciser la section en utilisant le paramètre section
<br>
### Liste les sections disponibles
```python
data = c.list_section()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ZephyrOff/zpp_config",
"name": "zpp_config",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "config file terminal zephyroff",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/16/4b/b60474815ab9d06b9f83b695332f46a9fb73c3f5bddd75f0b3054f82750d/zpp_config-1.2.5-py3-none-any.whl",
"platform": null,
"description": "# zpp-config\r\n## Informations\r\nLibrairie pour l'utilisation et la modification de fichier de configuration:<br>\r\n- Charger un ou plusieurs param\u00c3\u00a8tres\r\n- Modifier un param\u00c3\u00a8tre existant\r\n- Ajout un param\u00c3\u00a8tre ou une section\r\n- Supprimer un param\u00c3\u00a8tre ou une section\r\n- Lister les sections disponibles\r\n- Lister les param\u00c3\u00a8tres et/ou sections d\u00c3\u00a9sactiv\u00c3\u00a9s\r\n\r\nPrends en compte les param\u00c3\u00a8tres comment\u00c3\u00a9s.<br>\r\nCompatible avec les fichiers de configuration indent\u00c3\u00a9s.<br><br>\r\nTraduit les param\u00c3\u00a8tres pour les types str, int, float, bool, list, dict\r\n\r\n### Pr\u00c3\u00a9requis\r\n- Python 3\r\n<br>\r\n\r\n# Installation\r\n```console\r\npip install zpp_config\r\n```\r\n\r\n# Utilisation\r\n### Conseil d'importation du module\r\n```python\r\nfrom zpp_config import Config\r\n```\r\n\r\n<br>\r\n\r\n### Exemple de fichier de config\r\n```xml\r\n[section]\r\n\tvalue1 = key1\r\n\tvalue2 = key2\r\n\tvalue3 = key3\r\n\r\n[section2]\r\n\tvalue1 = key1\r\n\tvalue2 = key2\r\n\tvalue3 = key3\r\n```\r\n\r\n<br>\r\n\r\n### Initialisaton d'un fichier de configuration\r\n```python\r\nc = Config(\"conf.ini\")\r\n```\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- separator: D\u00c3\u00a9finir le s\u00c3\u00a9parateur entre la cl\u00c3\u00a9 et la valeur dans le fichier. (Par d\u00c3\u00a9faut: \" = \") \r\n>- escape_line: D\u00c3\u00a9finir le caract\u00c3\u00a8re utilis\u00c3\u00a9 pour commenter une valeur ou une section. (Par d\u00c3\u00a9faut: \"#\")\r\n>- auto_create: Cr\u00c3\u00a9er le fichier de configuration s'il n'existe pas. (Par d\u00c3\u00a9faut: \"False\")\r\n>- read_only: Ouvrir le fichier de configuration en lecture seule. (Par d\u00c3\u00a9faut: \"False\")\r\n\r\n<br>\r\n\r\n### Chargement de param\u00c3\u00a8tre\r\n\r\nLa fonction renvoie la valeur si un unique param\u00c3\u00a8tre a \u00c3\u00a9t\u00c3\u00a9 trouv\u00c3\u00a9, sinon renvoie un dictionnaire avec les diff\u00c3\u00a9rentes valeurs trouv\u00c3\u00a9es (class\u00c3\u00a9 par section)\r\nRenvoie un tableau vide si aucun param\u00c3\u00a8tre n'a \u00c3\u00a9t\u00c3\u00a9 trouv\u00c3\u00a9\r\n\r\n#### Chargement de tous les param\u00c3\u00a8tres\r\n```python\r\ndata = c.load()\r\n```\r\n#### Chargement d'une section du fichier\r\n```python\r\ndata = c.load(section='section_name')\r\n```\r\n#### Chargement d'une valeur dans tout le fichier\r\n```python\r\ndata = c.load(val='value_name')\r\n```\r\n#### Chargement d'une valeur dans une section sp\u00c3\u00a9cifique\r\n```python\r\ndata = c.load(val='value_name', section='section_name')\r\n```\r\n\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- default: Pour initialiser une valeur par d\u00c3\u00a9faut si aucun r\u00c3\u00a9sultat est trouv\u00c3\u00a9 \r\n\r\n\r\n<br>\r\n\r\n### Changement de param\u00c3\u00a8tre\r\n#### Changement d'une valeur dans tout le fichier\r\n```python\r\nc.change(val='value_name', key='key_value')\r\n```\r\n\r\n#### Changement d'une valeur dans une section sp\u00c3\u00a9cifique\r\n```python\r\nc.change(val='value_name', key='key_value', section='section_name')\r\n```\r\n\r\n<br>\r\n\r\n### Ajout de param\u00c3\u00a8tre ou de section\r\n\r\nAjoute une section ou un param\u00c3\u00a8tre dans le fichier de configuration.\r\nDans le cas de l'ajout d'un param\u00c3\u00a8tre, rajoute la section si elle n'existe pas.\r\n\r\n#### Ajout d'une section\r\n```python\r\nc.add(section='section_name')\r\n```\r\n\r\n#### Ajout d'un param\u00c3\u00a8tre dans une section\r\n```python\r\nc.add(val='value_name', key='key_value', section='section_name')\r\n```\r\n> Si aucune section est d\u00c3\u00a9fini, rajoute le param\u00c3\u00a8tre en dehors des sections.\r\n\r\n<br>\r\n\r\n### Suppression de param\u00c3\u00a8tre ou de section\r\n\r\n#### Suppression d'une section\r\n```python\r\nc.delete(section='section_name')\r\n```\r\n\r\n#### Suppression d'un param\u00c3\u00a8tre dans une section\r\n```python\r\nc.delete(val='value_name', section='section_name')\r\n```\r\n> Si aucune section est d\u00c3\u00a9fini, recherche le param\u00c3\u00a8tre en dehors des sections.\r\n\r\n<br>\r\n\r\n### Liste des param\u00c3\u00a8tres non pris en compte\r\n\r\nRetourne la liste des param\u00c3\u00a8tres qui sont non pris en compte dans le fichier de configuration.\r\n\r\n```python\r\ndata = c.disabled_line()\r\n```\r\n> Possibilit\u00c3\u00a9 de pr\u00c3\u00a9ciser la section en utilisant le param\u00c3\u00a8tre section\r\n\r\n<br>\r\n\r\n### Liste les sections disponibles\r\n```python\r\ndata = c.list_section()\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Module pour le chargement et la modification de fichier de configuration",
"version": "1.2.5",
"project_urls": {
"Documentation": "https://github.com/ZephyrOff/zpp_config",
"Homepage": "https://github.com/ZephyrOff/zpp_config"
},
"split_keywords": [
"config",
"file",
"terminal",
"zephyroff"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "164bb60474815ab9d06b9f83b695332f46a9fb73c3f5bddd75f0b3054f82750d",
"md5": "c77f470670329a14e4979ac3f1485ba1",
"sha256": "ce8eab3a026a6ccefbc30e88369f1e61992b5b1ca9f190a7a3d6886a138415f2"
},
"downloads": -1,
"filename": "zpp_config-1.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c77f470670329a14e4979ac3f1485ba1",
"packagetype": "bdist_wheel",
"python_version": "source",
"requires_python": null,
"size": 5927,
"upload_time": "2024-09-11T09:29:11",
"upload_time_iso_8601": "2024-09-11T09:29:11.570288Z",
"url": "https://files.pythonhosted.org/packages/16/4b/b60474815ab9d06b9f83b695332f46a9fb73c3f5bddd75f0b3054f82750d/zpp_config-1.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b08209201e5fcaa87476dcc238e18f19ea8c65b0a5932f62a4253255ee408a27",
"md5": "4fc35333e4468fac5b99b5eda803818c",
"sha256": "39af16c9e44bfcf79a33619324ebd3c9b08637b09e1de2c47bf3d486a980b9c8"
},
"downloads": -1,
"filename": "zpp_config-1.2.5.tar.gz",
"has_sig": false,
"md5_digest": "4fc35333e4468fac5b99b5eda803818c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6086,
"upload_time": "2024-09-11T09:29:12",
"upload_time_iso_8601": "2024-09-11T09:29:12.731705Z",
"url": "https://files.pythonhosted.org/packages/b0/82/09201e5fcaa87476dcc238e18f19ea8c65b0a5932f62a4253255ee408a27/zpp_config-1.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 09:29:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ZephyrOff",
"github_project": "zpp_config",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zpp_config"
}
JSON
