Skip to content

Latest commit

 

History

History
196 lines (125 loc) · 6.78 KB

installation.rst

File metadata and controls

196 lines (125 loc) · 6.78 KB
Raw

Installation

Dépendances

Patacrep est un projet reposant sur beaucoup de techniques, il a donc un certain nombre de dépendances à installer pour le faire fonctionner. Ces dépendances sont les mêmes pour tous les systèmes d'exploitation, mais la méthode d'installation diffère. Ces dépendances sont les suivantes :

  • Python 3.3 ou plus récent. Python 2 n'est pas supporté ;
  • LaTeX, et en particulier lualatex ;

Patacrep a aussi des dépendances optionnelles, qui peuvent ajouter des fonctionnalités, mais ne sont pas obligatoires :

  • Lilypond, pour compiler des partitions.

GNU/Linux

Il n'existe pas (pour le moment ?) de paquet pour les différentes distributions. En attendant, patacrep peut être installé en utilisant pip (éventuellement dans un virtualenv, pour garder un environnement d'installation propre). Voir la :ref:`section suivante <install_pip>` pour les instructions.

Voici quelques informations supplémentaires pour certaines distributions.

Debian

Il n'existe pas (encore ?) de paquet debian pour patacrep. Les paquets à installer sous Debian (et ses dérivées comme Ubuntu) sont :

  • Python 3.4

  • LaTeX :

    • Nécessaires : texlive texlive-latex-base texlive-latex-recommended texlive-latex-extra
    • Optionnel pour patacrep, nécessaire pour patadata : texlive-lang-english texlive-lang-french texlive-lang-portuguese texlive-lang-spanish texlive-lang-italian texlive-fonts-extra

  • Lilypond (optionnel) : lilypond

Il est aussi possible, en utilisant stdeb, de créer un paquet :file:`.deb` à la volée:

python setup.py --command-packages=stdeb.command bdist_deb
sudo dpkg -i deb_dist/python3-patacrep_5.0.0-1_all.deb

Ubuntu 16.04

En plus des paquets précédent, il est nécessaire pour que LaTeX fonctionne bien d'installer les deux paquets suivants :

apt-get install texlive-luatex  texlive-xetex

CentOS 6.5

Sur CentOS 6.5, un certain nombre de logiciels par défaut sont trop anciens pour faire fonctionner Patacrep correctement. En particulier, vous devriez utiliser une version récente de TeXLive, et installer ghostscript en version 9.

MacOSX

Vous devrez installer les dépendaces suivantes :

  • Python 3.

  • LaTeX. La distribution MacTeX est la plus simple à installer. Une installation personnalisée de TeXLive fonctionnera aussi si vous savez ce que vous faites.

  • Lilypond peut être utile si vous souhaitez compiler les partitions dans les chansons. Ce n'est toutefois pas une dépendance obligatoire. Vous pouvez le télécharger à cette adresse. Décompressez l'archive, puis placez-la dans :file:`/Applications`. Vous devrez ajouter un lien vers lilypond pour que songbook puisse le trouver en lançant les commandes suivantes dans un Terminal :

    sudo ln -s /Applications/LilyPond.app/Contents/Resources/bin/lilypond /usr/local/bin/lilypond
echo "export PATH=$PATH:\usr\local\bin" >> ~/.bashrc
La première commande va vous demander votre mot de passe administrateur.

Windows

Voici où vous pourez trouver les dépendances nécessaires :

Installation depuis PyPi

Une fois les dépendances installées, vous pouvez vérifier que tout s'est bien passé en lançant les commandes

python --version
lualatex --version

# Uniquement si vous avez installé lilypond
lilypond --version

Si le numéro de version s'affiche, tout va bien, si vous avez une erreur command not found, il y a un problème.

Pour la suite, la bibliothèque Patacrep et le programme :command:`songbook` sont disponibles sur le Python Packages Index, vous pouvez donc les installer avec pip.

Sans :ref:`virtualenv <virtualenv>`

pip3 install patacrep

Puis pour tester si tout a bien fonctionné

songbook --version

Avec :ref:`virtualenv <virtualenv>`

Pour éviter de mélanger les installations système (par apt, yum ou autre) et les installations de pip, il est recommandé d'installer l'application localement dans un virtualenv:

$ virtualenv -p python3 virtualenv
Already using interpreter /usr/bin/python3
Using base prefix '/usr'
New python executable in virtualenv/bin/python3
Also creating executable in virtualenv/bin/python
Installing setuptools, pip...done.
$ . virtualenv/bin/activate
(virtualenv)$ pip install patacrep
...
$ songbook --version
...

Si vous optez pour une installation dans un virtualenv, il faudra lancer la commande

. PATH_TO_VIRTUALENV/bin/activate

avant chaque utilisation de :command:`songbook` ou de patacrep.

Mac OS X

Si vous avez des erreurs lors de l'installation, deux cas sont possibles :

  • erreur permission denied : vous n'avez pas de droits en écriture dans :file:`/usr/bin`. Ajoutez sudo devant la commande fautive, et relancez-la (sudo pip3 install patacrep). Un mot de passe administrateur vous sera demandé.

  • songbook: command not found, c'est que :file:`/usr/local/bin` n'est pas dans votre PATH. Pour l'ajouter, exécutez la commande

    echo "export PATH=$PATH:/usr/local/bin" >> ~/.bashrc

Installation de la version de développement

Pour obtenir la version de développement, il est possible de télécharger les sources en utilisant git :

git clone https://github.com/patacrep/patacrep.git
cd patacrep
pip3 install -r Requirements.txt
python3 setup.py install

Pour mettre à jour la version de développement, utilisez simplement

git pull
pip3 install -r Requirements.txt
python3 setup.py install

depuis le dossier :file:`patacrep`

Mise à jour

Pour effectuer une mise à jour de Patacrep, vérifiez que les dépendances sont à jour, puis lancez la commande

pip3 install --upgrade patacrep