# zpp-browser
## Informations
Librairie pour l'utilisateur d'un explorateur de fichier en cli pour la sélection d'un fichier
### Prérequis
- Python 3
<br>
# Installation
```console
pip install zpp_browser
```
# Utilisation
### Conseil d'importation du module
```python
from zpp_browser import Browser
```
<br>
### Initialisaton du browser
```python
c = Browser("Chemin_de_depart")
```
>En paramètre supplémentaire, nous pouvons mettre:<br/>
>- Filter: Permet de filtrer sur une liste d'extension de fichier. (Par défaut: ne filtre pas)
>- ShowHidden: Afficher les fichiers et dossiers cachés. True ou False (Par défaut: True)
>- ShowDir: Afficher les dossiers. True ou False (Par défaut: True)
>- ShowFirst: Choisir si on souhaite afficher les dossiers ou les fichiers en premier. dir, file ou None (Par défaut: dir)
>- Color: Permet de configurer la colorisation des fichiers en fonction de l'extensions (Voir annexe pour la configuration)
>- Pointer: Choisir un pointer custom (Par défaut: " >")
>- Padding: Choisir la taille de la marge à gauche (Par defaut: 2)
### Configuration des couleurs
Il est possible d'envoyer à la fonction une liste de couleur pour permettre de customiser l'affichage des fichiers en fonction de leur extension.
Pour cela, la fonction attends une liste à 2 dimensions contenant [extension, couleur du texte, couleur de fond]
<br>
Pour l'extension il suffit de mettre le nom.
Par exemple, .txt pour les fichiers txt
Cas particulier pour la configuration de certains éléments:
- \_\_default__: Pour la couleur par défaut
- \_\_hidden__: Pour les fichiers et dossiers cachés
- \_\_dir__: Pour les dossiers
- \_\_selected__: Pour l'élément sélectionné
Dans le cas où on veut configurer plusieurs extensions avec la même couleur, il suffit de mettre une virgule entre le nom des extensions.
Exemple:
```python
['.crt,.pfx,.key,.txt','yellow','black']
```
#### Exemple de liste de couleur
```python
[['__default__','white','black'],['__hidden__','red','black'],['__selected__','red','black'],['__dir__','green','black'],['.crt,.pfx,.key,.txt','yellow','black']]
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ZephyrOff/zpp_browser",
"name": "zpp_browser",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1a/8d/14ea4257766269d948369f41339957dada871f41dd6c94f6f9022a5fccab/zpp_browser-1.0.2-py3-none-any.whl",
"platform": null,
"description": "# zpp-browser\r\n## Informations\r\nLibrairie pour l'utilisateur d'un explorateur de fichier en cli pour la s\u00c3\u00a9lection d'un fichier\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_browser\r\n```\r\n\r\n# Utilisation\r\n### Conseil d'importation du module\r\n```python\r\nfrom zpp_browser import Browser\r\n```\r\n\r\n<br>\r\n\r\n### Initialisaton du browser\r\n```python\r\nc = Browser(\"Chemin_de_depart\")\r\n```\r\n>En param\u00c3\u00a8tre suppl\u00c3\u00a9mentaire, nous pouvons mettre:<br/>\r\n>- Filter: Permet de filtrer sur une liste d'extension de fichier. (Par d\u00c3\u00a9faut: ne filtre pas)\r\n>- ShowHidden: Afficher les fichiers et dossiers cach\u00c3\u00a9s. True ou False (Par d\u00c3\u00a9faut: True)\r\n>- ShowDir: Afficher les dossiers. True ou False (Par d\u00c3\u00a9faut: True)\r\n>- ShowFirst: Choisir si on souhaite afficher les dossiers ou les fichiers en premier. dir, file ou None (Par d\u00c3\u00a9faut: dir)\r\n>- Color: Permet de configurer la colorisation des fichiers en fonction de l'extensions (Voir annexe pour la configuration)\r\n>- Pointer: Choisir un pointer custom (Par d\u00c3\u00a9faut: \" >\")\r\n>- Padding: Choisir la taille de la marge \u00c3\u00a0 gauche (Par defaut: 2)\r\n\r\n### Configuration des couleurs\r\n\r\nIl est possible d'envoyer \u00c3\u00a0 la fonction une liste de couleur pour permettre de customiser l'affichage des fichiers en fonction de leur extension.\r\nPour cela, la fonction attends une liste \u00c3\u00a0 2 dimensions contenant [extension, couleur du texte, couleur de fond]\r\n<br>\r\n\r\nPour l'extension il suffit de mettre le nom. \r\nPar exemple, .txt pour les fichiers txt\r\nCas particulier pour la configuration de certains \u00c3\u00a9l\u00c3\u00a9ments:\r\n- \\_\\_default__: Pour la couleur par d\u00c3\u00a9faut\r\n- \\_\\_hidden__: Pour les fichiers et dossiers cach\u00c3\u00a9s\r\n- \\_\\_dir__: Pour les dossiers\r\n- \\_\\_selected__: Pour l'\u00c3\u00a9l\u00c3\u00a9ment s\u00c3\u00a9lectionn\u00c3\u00a9\r\n\r\nDans le cas o\u00c3\u00b9 on veut configurer plusieurs extensions avec la m\u00c3\u00aame couleur, il suffit de mettre une virgule entre le nom des extensions.\r\nExemple:\r\n```python\r\n['.crt,.pfx,.key,.txt','yellow','black']\r\n```\r\n\r\n#### Exemple de liste de couleur\r\n```python\r\n[['__default__','white','black'],['__hidden__','red','black'],['__selected__','red','black'],['__dir__','green','black'],['.crt,.pfx,.key,.txt','yellow','black']]\r\n```\r\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Browser (Explorateur) de fichier en cli",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://github.com/ZephyrOff/zpp_browser",
"Homepage": "https://github.com/ZephyrOff/zpp_browser"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1a8d14ea4257766269d948369f41339957dada871f41dd6c94f6f9022a5fccab",
"md5": "f1b4c7987abd567e1d98d8fc8cad9f5d",
"sha256": "02084b9f6c450aaf96c48fdf73b6c7f87fb0f4fd25698a7c2db95d4ba2ae375f"
},
"downloads": -1,
"filename": "zpp_browser-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1b4c7987abd567e1d98d8fc8cad9f5d",
"packagetype": "bdist_wheel",
"python_version": "source",
"requires_python": null,
"size": 7787,
"upload_time": "2024-09-11T10:05:58",
"upload_time_iso_8601": "2024-09-11T10:05:58.320695Z",
"url": "https://files.pythonhosted.org/packages/1a/8d/14ea4257766269d948369f41339957dada871f41dd6c94f6f9022a5fccab/zpp_browser-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9e4a79561ced4ea9ba21bdff560f6a62db765720f8d76ac672bd137a37a43924",
"md5": "154eb544f629e02838fb495df126f332",
"sha256": "c22d4ce2a0282bc07aa2d73fbe0a085184ca9433de8e8cf357db93d2bc1a5ea0"
},
"downloads": -1,
"filename": "zpp_browser-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "154eb544f629e02838fb495df126f332",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7524,
"upload_time": "2024-09-11T10:05:59",
"upload_time_iso_8601": "2024-09-11T10:05:59.325629Z",
"url": "https://files.pythonhosted.org/packages/9e/4a/79561ced4ea9ba21bdff560f6a62db765720f8d76ac672bd137a37a43924/zpp_browser-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 10:05:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ZephyrOff",
"github_project": "zpp_browser",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "zpp_browser"
}
JSON
