Guide utilisateur

Guide utilisateur

Bienvenue dans ce guide utilisateur pour le projet scolaire de l'UE GL02.
Le but est de créer un logiciel en ligne de commande d'analyse de mails.

Pré-requis

Pour executer ce projet, il faut avoir NodeJS, et npm (qui est installé avec NodeJS). Il est aussi recommandé d'avoir SVN, pour cloner le projet.

Installation

Pour télécharger le projet, il est conseillé d'utiliser SVN. Puis, clonez le projet, en utilisant la commande proposée par SourceForge dans l'onglet "Code" ci-dessus. Si vous ne voulez pas passer par SVN, vous pouvez utiliser la fonctionnalité "Download Snapshot" de SourceForge.
Il faut aussi installer les dépendances du projet. Pour cela, en ligne de commande, allez dans le dossier projet-gl02-2, puis executez npm install.

Utilisation

Le logiciel étant en ligne de commande avec NodeJS, toute commande s'executera en utiliant node capo.js <commande>. Pour visualiser la liste des commandes au sein du logiciel, utilisez la commande help, en écrivant node capo.js help.

Pour chaque commande, un dataset est nécessaire. Il permet de savoir où chercher les données. On le fournira à la commande via le paramètre <dir>. Pour le projet actuel, en utilisant le dataset d'exemple, il faudra écrire ...

Voici les commandes possibles:

• afficherMailPeriode <dir> <dateTime1> <dateTime2> affiche le nombre d’emails échangés durant une période donnée.
  Exemple: node capo.js afficherMailPeriode ../donneesSujetB 04/05/2006 07/08/2009

• topTenSpeakers <dir> affiche le top 10 des personnes avec qui un collaborateur donné a échangé.
  Exemple: node capo.js topTenSpeakers ..\donneesSujetB\arnold-j\

• topTermes <dir> affiche le top 10 des termes les plus utilisés.
  Exemple: node capo.js topTermes ..\donneesSujetB

• extraire <dir> [ids...] extrait les emails vers un fichier .txt depuis leurs ids.
  Exemple: node capo.js extraire ..\donneesSujetB 33025919.1075857594206.JavaMail.evans@thyme 9214363.1075857594228.JavaMail.evans@thyme

• findEmails <dir> <-email | -nom | -prenom> permet de chercher des emails depuis leur adresse, nom et prénom.
  Exemples:
  node capo.js ..\donneesSujetB findEmails -e john.arnold@enron.com
node capo.js ..\donneesSujetB findEmails -n arnold
node capo.js ..\donneesSujetB findEmails -p john

• buzzyDay <dir> <date1> <date2> afficher le nombre d’emails échangés durant une période donnée.
  Exemple: node capo.js buzzyDay ../donneesSujetB 10/10/2001 10/10/2010