# InclusionMap
## Installation
`pip install InclusionMap`
## Utilisation
`inclusionmap LIST_OF_DIRECTORIES ... -l PROGRAMMING_LANGUAGE [OPTIONS]`
ou
`python3 -m inclusion_map LIST_OF_DIRECTORIES ... -l PROGRAMMING_LANGUAGE [OPTIONS]`
### Options générales
`LIST_OF_DIRECTORIES ...`
Répertoires racines du projet.
`[{-I|--include-dirs}]`
Répertoires dans lesquels commence la recherche des fichiers inclus.
Par défaut, cherche dans tous les répertoires racines.
`{-l|--language} {c|c++|python}`
Langage dans lequel sont écrits les fichiers du projet.
`[{-e|--extensions} LIST_OF_EXTENSIONS ...]`
Extensions des fichiers à afficher dans le graphe.
Par défaut, détermine automatiquement les extensions selon le langage utilisé.
`[{-i|--ignore-dirs} LIST_OF_STRINGS ...]`
Répertoires à ignorer.
Par défaut, détermine automatiquement les répertoires à ignorer selon le langage
utilisé (par exemple `__pycache__` pour python).
`[{-s|--simplify}]`
Simplifie le graphe en exploitant la transitivité de la relation d'inclusion.
Si x inclut y, y inclut z et x inclut z, alors n'affiche pas le fait que x inclut z.
### Options graphiques
`[--display-algorithm {patchwork|circo|osage|sfdp|dot|twopi|neato|fdp}]`
Nom d'un algorithme d'affichage de graphe.
Pour utiliser un autre algorithme d'affichage que `default`, il est nécessaire d'installer le paquet [pygraphviz](https://pygraphviz.github.io/documentation/stable/install.html).
`[--font-size INTEGER]`
Taille de la police utilisée pour écrire les noms des nœuds.
### TODO: Commande `inverted`
Construit le graphe des dépendances inverses d'un ensemble donné de fichiers.
I.e part d'un ensemble donné de fichiers et affiche sur le graphe les fichiers
qui incluent au moins l'un d'eux.
`LIST_OF_FILES ...`
Fichiers de départ à partir desquels on parcourt les dépendances inverses.
`[--max-depth INTEGER]`
Profondeur maximale des nœuds apparaissant sur le graphe (Infinie par défaut).
Raw data
{
"_id": null,
"home_page": "https://github.com/VictorLaugt/InclusionMap",
"name": "InclusionMap",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "dependency graph map programming project tool",
"author": "Victor La\u00fcgt",
"author_email": "victorlaugtdev@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b1/fb/75cc86093fb92512f104e4a8e26968398d887e33404331368472209d393c/inclusionmap-1.5.1.tar.gz",
"platform": null,
"description": "# InclusionMap\n\n\n\n\n## Installation\n`pip install InclusionMap`\n\n## Utilisation\n`inclusionmap LIST_OF_DIRECTORIES ... -l PROGRAMMING_LANGUAGE [OPTIONS]`\nou\n`python3 -m inclusion_map LIST_OF_DIRECTORIES ... -l PROGRAMMING_LANGUAGE [OPTIONS]`\n\n### Options g\u00e9n\u00e9rales\n`LIST_OF_DIRECTORIES ...`\nR\u00e9pertoires racines du projet.\n\n`[{-I|--include-dirs}]`\nR\u00e9pertoires dans lesquels commence la recherche des fichiers inclus.\nPar d\u00e9faut, cherche dans tous les r\u00e9pertoires racines.\n\n\n`{-l|--language} {c|c++|python}`\nLangage dans lequel sont \u00e9crits les fichiers du projet.\n\n`[{-e|--extensions} LIST_OF_EXTENSIONS ...]`\nExtensions des fichiers \u00e0 afficher dans le graphe.\nPar d\u00e9faut, d\u00e9termine automatiquement les extensions selon le langage utilis\u00e9.\n\n`[{-i|--ignore-dirs} LIST_OF_STRINGS ...]`\nR\u00e9pertoires \u00e0 ignorer.\nPar d\u00e9faut, d\u00e9termine automatiquement les r\u00e9pertoires \u00e0 ignorer selon le langage\nutilis\u00e9 (par exemple `__pycache__` pour python).\n\n\n`[{-s|--simplify}]`\nSimplifie le graphe en exploitant la transitivit\u00e9 de la relation d'inclusion.\nSi x inclut y, y inclut z et x inclut z, alors n'affiche pas le fait que x inclut z.\n\n\n### Options graphiques\n`[--display-algorithm {patchwork|circo|osage|sfdp|dot|twopi|neato|fdp}]`\nNom d'un algorithme d'affichage de graphe.\nPour utiliser un autre algorithme d'affichage que `default`, il est n\u00e9cessaire d'installer le paquet [pygraphviz](https://pygraphviz.github.io/documentation/stable/install.html).\n\n`[--font-size INTEGER]`\nTaille de la police utilis\u00e9e pour \u00e9crire les noms des n\u0153uds.\n\n\n### TODO: Commande `inverted`\nConstruit le graphe des d\u00e9pendances inverses d'un ensemble donn\u00e9 de fichiers.\nI.e part d'un ensemble donn\u00e9 de fichiers et affiche sur le graphe les fichiers\nqui incluent au moins l'un d'eux.\n\n`LIST_OF_FILES ...`\nFichiers de d\u00e9part \u00e0 partir desquels on parcourt les d\u00e9pendances inverses.\n\n`[--max-depth INTEGER]`\nProfondeur maximale des n\u0153uds apparaissant sur le graphe (Infinie par d\u00e9faut).\n",
"bugtrack_url": null,
"license": "GPLv3",
"summary": "A tool for generating the inclusion map of a programming project. Several programming languages are supported.",
"version": "1.5.1",
"project_urls": {
"Homepage": "https://github.com/VictorLaugt/InclusionMap"
},
"split_keywords": [
"dependency",
"graph",
"map",
"programming",
"project",
"tool"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ef2faf7a1b73d6d74f5b00512145a40430b19298eff689feac3c84ad4eb34810",
"md5": "f7a1138e6b7121d91c83d43d956af425",
"sha256": "cde30518bad9969840c524c9dcca0dce9f2cd7a6dcb51587f971cf86d4b67034"
},
"downloads": -1,
"filename": "InclusionMap-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f7a1138e6b7121d91c83d43d956af425",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 25251,
"upload_time": "2025-03-01T20:27:38",
"upload_time_iso_8601": "2025-03-01T20:27:38.624967Z",
"url": "https://files.pythonhosted.org/packages/ef/2f/af7a1b73d6d74f5b00512145a40430b19298eff689feac3c84ad4eb34810/InclusionMap-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b1fb75cc86093fb92512f104e4a8e26968398d887e33404331368472209d393c",
"md5": "47347cd74452440bbaf3c9a115a65e09",
"sha256": "db8e9bfd0985ea9aaeac1831571dc270ef5804c24481801264e3b891aa1e61ca"
},
"downloads": -1,
"filename": "inclusionmap-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "47347cd74452440bbaf3c9a115a65e09",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 23454,
"upload_time": "2025-03-01T20:27:40",
"upload_time_iso_8601": "2025-03-01T20:27:40.579691Z",
"url": "https://files.pythonhosted.org/packages/b1/fb/75cc86093fb92512f104e4a8e26968398d887e33404331368472209d393c/inclusionmap-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-01 20:27:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "VictorLaugt",
"github_project": "InclusionMap",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "distinctipy",
"specs": [
[
"==",
"1.3.4"
]
]
},
{
"name": "matplotlib",
"specs": [
[
">=",
"3.8.2"
]
]
},
{
"name": "netgraph",
"specs": [
[
">=",
"4.13.2"
]
]
},
{
"name": "networkx",
"specs": [
[
">=",
"3.2.1"
]
]
},
{
"name": "numpy",
"specs": [
[
">=",
"2.0.1"
]
]
},
{
"name": "ijson",
"specs": [
[
">=",
"3.3.0"
]
]
}
],
"lcname": "inclusionmap"
}
JSON
