# Introduction
[![PyPi](https://img.shields.io/pypi/v/iparapheur-utils.svg)](https://pypi.org/project/iparapheur-utils)
Ce composant logiciel fournit :
- une librairie écrite en Python permettant la communication avec
l'application [i-Parapheur](https://www.libriciel.fr/iparapheur/) en version
4.2+, au travers de l'API REST ou via webservice SOAP.
- quelques commandes accessibles depuis un shell standard, pour faciliter
certaines opérations d'exploitation.
# "iparapheur-utils" - Installation
## Pré-requis
Une instance de i-Parapheur respectant les pré-requis i-Parapheur.
Un environnement d'exécution Python opérationnel.
## Déploiement standard sur "Ubuntu 18.04 LTS"
Sur une distribution Ubuntu 18.04 LTS :
* ajout de l'outil ` pip ` depuis un terminal BASH :
```bash
sudo bash
curl https://bootstrap.pypa.io/get-pip.py | python
```
* installation du paquet python `iparapheur-utils`, depuis un terminal BASH :
```bash
sudo pip install iparapheur-utils
```
### Particularité sur "Ubuntu 20.04 LTS"
Pour déployer "` pip `":
```bash
sudo bash
curl https://bootstrap.pypa.io/pip/2.7/get-pip.py | python
```
### Particularité sur CentOS / RHEL :
* Version 7 : Cette version requiert l'installation de paquets supplémentaires :
`yum install libffi-devel gcc openssl-devel`
## Problèmes d'installation connus et solutions
### python2 et python3 coexistent sur la machine
Lancer les commandes pour python2, spécifiquement (partant du principe que
`python2` pointe sur l'exécutable python 2)
```bash
curl https://bootstrap.pypa.io/get-pip.py | python2
sudo python2 -m pip install iparapheur-utils
```
### Erreur urllib3 : "No module named ordered_dict"
Une dépendance de iparapheur-utils est installée dans une mauvaise version, non
supportée (eg urllib3 v 1.24).
Il faut la désinstaller et la réinstaller dans la bonne version (v 1.23).
```bash
sudo pip uninstall urllib3
sudo pip install urllib3==1.23
```
### Cas d'environnement avec MitM
Certains environnements réseau bloquent l'accès à pypi.org, avec un message
ressemblant à :
"`SSL Error: Certificate_Verify_Failed`".
> Could not fetch URL https://pypi.org/…/: There was a problem confirming the ssl certificate: HTTPSConnectionPool(host=’pypi.org’, port=443): Max retries exceeded with url: /…/ (Caused by SSLError(SSLCertVerificationError(1, ‘[ SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: …
Il est possible de passer outre, au prix d'une réduction de la confiance, avec l'argument `--trusted-host`
```bash
sudo pip install --trusted-host pypi.org iparapheur-utils
```
# Usage des commandes offertes depuis BASH
Ces commandes sont actuellement disponibles :
- [`ph-init`](#ph-init)
- [`ph-check`](#ph-check)
- [`ph-echo`](#ph-echo)
- [`ph-recupArchives`](#ph-recuparchives)
- [`ph-export`](#ph-export)
- [`ph-import`](#ph-import)
- [`ph-rename`](#ph-rename)
- [`ph-removeldap`](#ph-removeldap)
- [`ph-pushdoc`](#ph-pushdoc)
- [`ph-ipclean`](#ph-ipclean)
- [`ph-ldapsearch`](#ph-ldapsearch)
- [`ph-count_files`](#ph-count_files)
- [`ph-reset_admin_password`](#ph-reset_admin_password)
- [`ph-patch`](#ph-patch)
- [`ph-recupfull`](#ph-recupfull)
> Remarques : Elles sont conçues pour être exécutées en environnement BASH standard: ligne de commande, ou script BASH.
Aucune qualification à ce stade pour l'usage de ces commandes dans un interpréteur Python.
## `ph-init`
Cette commande permet la génération d'un fichier de configuration "par défaut", qu'il faut bien sûr adapter au serveur.
Exemple d'utilisation :
```
usage: ph-init [-h] [-p P] [-c {recuparchives,export,import}]
Génère un fichier de configuration par défaut dans le répertoire courant
Arguments:
-h, --help Affiche ce message et quitte
-p P Chemin du fichier de configuration
-c {recuparchives,export,import}
Commande pour laquelle générer le fichier de
configuration
```
Le lancement de la commande génère un fichier `iparapheur-utils.cfg`, lu par défaut lors de l'appel des autres fonctions
## `ph-check`
Lance le script de check d'installation. Pas de pré-requis particulier.
## `ph-echo`
Lance la fonction `echo` vers le i-Parapheur désigné dans le fichier de configuration.
Exemple d'utilisation :
```bash
ph-echo -h
---
usage: ph-echo [-h] [-s S] [-c C] [-u U] [-p P]
Lance un echo via webservice sur un iParapheur
Arguments:
-h, --help Affiche ce message et quitte
-s S URL du serveur iParapheur
-c C Fichier de configuration
-u U Utilisateur
-p P Mot de passe
```
## `ph-recupArchives`
Lance la fonction de récupération ou/et de purge des archives.
Il est vivement conseillé d'utiliser la commande `ph-init -c recuparchives` afin de générer un squelette de fichier de
configuration complet.
Exemple d'utilisation :
```
ph-recupArchives -h
---
usage: ph-recupArchives [-h] [-s S] [-c C] [-u U] [-p P] [-f F] [-ps PS]
[-r {true,false}] [-i {true,false}] [-pu {true,false}]
[-d {true,false}] [-t T] [-st ST] [-w W]
Lance une récupération / purge des archives
Arguments:
-h, --help Affiche ce message et quitte
-s S URL du serveur iParapheur
-c C Fichier de configuration
-u U Utilisateur
-p P Mot de passe
-f F Répertoire de destination
-ps PS Taille des pages à récupérer
-r {true,false} Chemins réduis des téléchargements
-i {true,false} Ajout identifiant alfresco dans le chemin complet (true par defaut)
-pu {true,false} Active la purge les données
-d {true,false} Télécharge les données
-t T Filtre sur type
-st ST Filtre sur sous-type
-w W Délai de conservation des données
```
## `ph-export`
Lance la fonction d'exportation de la configuration du parapheur vers un dossier.
Il est vivement conseillé d'utiliser la commande `ph-init -c export` afin de générer un squelette de fichier de
configuration complet. La liste des éléments à exporter peut être modifiée dans ce fichier.
**ATTENTION** : Seule la **configuration** du parapheur est exportée. Comprendre qu'aucun dossier, archive, statistique
ou historique n'est conservé.
Exemple d'utilisation :
```
usage: ph-export [-h] [-s S] [-c C] [-u U] [-p P] [-i I] [-dh DH] [-dp DP]
[-du DU] [-dpw DPW] [-dd DD] [-ou OU] [-og OG] [-ob OB] [-oc OC] [-ot OT] [-om OM] [-oq OQ] [-oa OA]
Exporte la configuration du parapheur ciblé vers un dossier
Arguments:
-h, --help Affiche ce message et quitte
-s S URL du serveur iParapheur
-c C Fichier de configuration
-u U Utilisateur administrateur
-p P Mot de passe
-i I Répertoire de destination
-dh DH IP du serveur mysql
-dp DP Port du serveur mysql
-du DU Utilisateur alfresco de mysql
-dpw DPW Mot de passe utilisateur alfresco de mysql
-dd DD Nom de la base mysql
-ou {true,false} Boolean importe les utilisateurs
-og {true,false} Boolean importe les groupes
-ob {true,false} Boolean importe les bureaux
-oc {true,false} Boolean importe les circuits
-ot {true,false} Boolean importe les types et sous-types
-om {true,false} Boolean importe les metadatas
-oq {true,false} Boolean importe les calques
-oa {true,false} Boolean importe les advanced
```
## `ph-import`
Lance la fonction d'importation de la configuration du parapheur à partir d'un dossier.
Il est vivement conseillé d'utiliser la commande `ph-init -c import` afin de générer un squelette de fichier de
configuration complet.
**ATTENTION** : Seule la **configuration** du parapheur est importée. Comprendre qu'aucun dossier, archive, statistique
ou historique n'est conservé.
Exemple d'utilisation :
```
usage: ph-import [-h] [-s
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
共92个文件
ftl:37个
py:23个
cfg:12个
资源分类:Python库 所属语言:Python 资源全名:iparapheur-utils.beta-0.0.1.post282890.tar.gz 资源来源:官方 安装方法:https://lanzao.blog.csdn.net/article/details/101784059
资源推荐
资源详情
资源评论
收起资源包目录
iparapheur-utils.beta-0.0.1.post282890.tar.gz (92个子文件)
iparapheur-utils.beta-0.0.1.post282890
MANIFEST.in 80B
PKG-INFO 22KB
parapheur
core.py 18KB
parapheur
Client.py 12KB
__init__.py 4KB
pprint.py 3KB
JSONHelper.py 3KB
Webservice.py 8KB
__init__.py 401B
configs
recupfull.cfg 769B
recuparchives.cfg 281B
reset_admin_password.cfg 102B
import.cfg 206B
template.cfg 97B
ldapsearch.cfg 155B
export.cfg 344B
pushdoc.cfg 173B
script.cfg 82B
patch.cfg 74B
script.cfg 82B
files
templates
parapheur-admin-transfert.ftl 5KB
parapheur-diffusion-retour.ftl 5KB
parapheur-mail-archive.ftl 4KB
parapheur-diffusion-archive.ftl 2KB
parapheur-owner-retour.ftl 5KB
parapheur-tiers-retour.ftl 77B
parapheur-mail-retard.ftl 4KB
parapheur-mail-reject.ftl 4KB
parapheur-signataires.ftl 6KB
parapheur-current-retard.ftl 5KB
parapheur-mail-approve.ftl 5KB
parapheur-mail-reviewing.ftl 4KB
parapheur-secretariat-relecture.ftl 5KB
parapheur-mail-moveAdmin.ftl 4KB
parapheur-current-reception.ftl 5KB
parapheur-diffusion-emission.ftl 5KB
parapheur-mail-delegation.ftl 4KB
parapheur-owner-archivage.ftl 5KB
parapheur-diffusion-tdt-ok.ftl 5KB
parapheur-next-reprise.ftl 3KB
parapheur-mail-deleteAdmin.ftl 3KB
parapheur-secretariat-retour.ftl 5KB
parapheur-mailsec-template.ftl 203B
parapheur-current-tdt-ok-archivage.ftl 5KB
parapheur-mail-print.ftl 4KB
parapheur-tiers.ftl 254B
parapheur-mail-remord.ftl 3KB
parapheur-tiers-visa.ftl 189B
parapheur-tiers-tdt-ok-archivage.ftl 245B
parapheur-admin-suppression.ftl 3KB
parapheur-secretariat-signature.ftl 5KB
parapheur-diffusion-visa.ftl 5KB
parapheur-digest-mail.ftl 9KB
parapheur-owner-reception.ftl 5KB
parapheur-mail-tiers.ftl 413B
parapheur-mail-resetpassword.ftl 4KB
parapheur-dossier-email.ftl 3KB
crontab
460.txt 2KB
468.txt 2KB
450.txt 2KB
470.txt 2KB
private.pem 2KB
public.pem 2KB
scripts
export_data.py 12KB
template.py 3KB
patch.py 390B
ldapsearch.py 3KB
recupfull.py 21KB
count_files.py 253B
change_name.py 2KB
checkInstallationIP.py 70KB
ipclean.py 249B
__init__.py 925B
javascript
removeNode.js 98B
remove_ldap.py 946B
recupArchives.py 13KB
script
ipclean.sh 4KB
patch.sh 2KB
count_files.sh 4KB
import_data.py 20KB
pushdoc.py 7KB
reset_admin_password.py 1KB
iparapheur_utils.beta.egg-info
PKG-INFO 22KB
requires.txt 79B
SOURCES.txt 4KB
entry_points.txt 700B
top_level.txt 10B
dependency_links.txt 1B
setup.cfg 38B
setup.py 2KB
CHANGELOG.md 10KB
README.md 17KB
共 92 条
- 1
资源评论
挣扎的蓝藻
- 粉丝: 13w+
- 资源: 15万+
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功