arboProject (Main)

Infos

Projet:arboProject
Nom du fichier:arboProject.py
Auteur:Poltergeist42
Version:20181006
dev langage:Python 3.6
Framework:

Descriptif

Projet:

Ce projet permet de créer une arborescence de dossier et de sous dossiers nécessaires à chaque nouveau projet. Ainsi que l’ensemble des fichiers qui y sont rattachés. Il permet également d’initialiser le dépôt Git et l’outil de documentation Sphinx.
Fichiers:

arboProject.py : c’est le programme principal. On peut le lancer par la commande :

python arboProject.py

ou utiliser une ou plusieurs options disponibles. Voir les options disponibles avec “–help”

python arboProject.py --help

ou

python arboProject.py -h

lexique

v_:variable
l_:list
t_:tuple
d_:dictionnaire
f_:fonction
C_:Class
i_:Instance
m_:Matrice
class _3_software.arboProject.C_Arbo

Class permettant la création d’une arborescence standardisée pour chaque nouveau projet

f_chkIfDir(v_dir, v_path=None)

Retourne Vrai si le dossier existe et Faux s’il n’existe pas.

  • Si aucun chemin n’est passé à “v_path”, c’est dans le répertoire courant que la recherche sera effectuée.
f_chkIfFile(v_file, v_path=None)

Retourne Vrai si le fichier existe et Faux s’il n’existe pas.

  • Si aucun chemin n’est passé à “v_path”, c’est dans le répertoire courant que la recherche sera effectuée.
f_copyFile()

Permet de copier tous les fichiers qui se trouvent dans le dossier “_3-2_sourcesFileToCopy” vers leur destination dans la nouvelle arborescence

f_createMakeBat(*args, **kwargs)

Retourne les informations pour la création du fichiers “make.bat”. Si le chemin de destination est différent du dossier par défaut (“….webDoc”), il faut passer un quatrième argument sous la forme d’une chaine de caractère représentant le chemin relatif vers le nouveau dossier de destination.

Cette Méthode est appelée par : “f_sphinxInit”. Ce fichier faisant parti des fichiers de configuration de Sphinx, il n’est pas généré depuis “createFile”.

f_createMakefile(*args, **kwargs)

Retourne les informations pour la création du fichiers “Makefile”. Si le chemin de destination est différent du dossier par défaut (“….webDoc”), il faut passer un quatrième argument sous la forme d’une chaine de caractère représentant le chemin relatif vers le nouveau dossier de destination.

Cette Méthode est appelée par : “f_sphinxInit”. Ce fichier faisant parti des fichiers de configuration de Sphinx, il n’est pas généré depuis “createFile”.

f_dir(*t_exeptArgs)

Création de la liste des dossiers et de leur sous dossiers.

Ces dossiers sont créés à partir du dictionnaire “_d_arboDir” qui est extrait du fichier “defArbo.json”.

f_dirInit()

récupération du répertoire de travail

f_getAuthor()

Retourne le nom contenu par “_v_author”. Par défaut se nom est “Poltergeist42”

f_getAuthorSite()

Retourne le nom contenu par “_v_author”. Par défaut se nom est “Poltergeist42”

f_getProjectName()

Permet de récupérer le nom du projet contenu dans “_v_projectName”

f_gitInit()

initialisation de git

f_loopFile(*args, **kwargs)

Permet de parcourir “_d_txtFileToCreate” pour créer les fichiers textes associés à chaque clef.

Ces fichiers sont créés à partir du dictionnaire “_d_txtFileToCreate” qui est extrait du fichier “defArbo.json”.

f_setAuthor(v_author=None)

Permet de définir un Auteur pour le projet. Par défaut cette valeur est fixée à “Poltergeist42”

f_setAuthorSite(v_authorSite=None)

Permet de définir un Auteur pour le projet. Par défaut cette valeur est fixée à “Poltergeist42”

f_setChangeConf(v_relativPath=False)

Permet de modifier le fichiers “conf.py” qui est générer par Sphinx. Le chemin relatif par défaut est : “../../”. Cette valeur est à modifier (v_relativPath)si l’arborescence utilisée est différente de l’arborescence par défaut.

Cette Méthode est appelée par : “f_sphinxInit”.

f_setProjectName(v_projectName=None)

Permet de définir le nom du projet

f_setToggleGitInit()

Permet de définir “_v_gitInit” à Vrai ou Faux. L’état est inversé à chaque appel

f_setToggleSphinxInit()

Permet de définir “_v_sphinxInit” à Vrai ou Faux. L’état est inversé à chaque appel

f_setToggleVerbose()

Permet de définir “_v_gitInit” à Vrai ou Faux. L’état est inversé à chaque appel

f_sphinxInit()

Initialisation de Sphinx

f_testFunc(*args, **kwargs)

Cette méthode permet de tester méthode pour éviter de devoir modifier la séquence exécutée dans le “main’. Elle s’active avec l’option -t ou –test.

f_wFile(v_fileName, v_txtData)

Permet de créer les fichiers texte dans l’arborescence du projet

_3_software.arboProject.main()

fonction principale