# Nexus.toml

Le fichier nexus.toml contient l'ensemble des informations et des paramètres qui seront nécessaire pour le bon fonctionnement de Nexus. Ces paramètres sont regroupés par section pour une meilleure compréhension.

Il est possible de retrouver facilement les informations d'un projet avec la commande project

nxs project

Contient les éléments de base sur la description du projet

name: le nom du projet
version: la version actuelle
description: la description du projet
mainfile: le fichier principal qui sera utilisé pour l'exécution du code ou encore la compilation du projet
requires-python: les prérequis de version Python

Contient les métadonnées qui seront utilisées pour rendre notre projet publiable.

authors: Les auteurs du projet (sous forme de liste)
maintainers: Les mainteneurs du projet (sous forme de liste)
readme: l'emplacement du fichier readme.md (pour la description principale qui sera utilisée)
license: le type de licence utilisée
license_file: l'emplacement du fichier de licence
keywords: les mots-clés qui seront définis pour rechercher le package dans les repo
classifiers: même remarque que keywords
copyright: pour spécifier d'éventuels copyright
changelog: l'emplacement du fichier de changelog

Contient les liens utiles affichés sur les repo

changelog: l'url vers le fichier de changelog
homepage: l'url vers la page d'accueil du projet
documentation: l'url vers la documentation

Contient l'ensemble des dépendances du projet avec comme format NOM_PACKAGE = "VERSION"

Des sous-sections windows et linux sont possibles pour préciser des dépendances spécifiques au système.

Contient les différentes informations qui seront utiles pour la création de package et la compilation.

packages: La liste des packages natif ou à installer nécessaire au projet
includes: la liste des modules internes au projet nécessaires
excludes: La liste des packages à exclure
include_files: La liste des fichiers annexes à intégrer au projet
optimize: niveau d'optimisation de la compilation (0 (disabled), 1 or 2)
no_compress: booléen qui définit si les dépendances sont dans fichier zip sans compression lors de la compilation
GUI: booléen qui définit si le projet a une partie graphique
icon: chemin vers le fichier icon qui sera utilisé par l'application compilée

Contient les informations spécifiques pour la création de package

platforms: précise la plateforme nécessaire
Une sous-sectoin entry_points contient console_scripts qui contient la liste des console_scripts qui seront créés avec notre package.