RaptorXML+XBRL Server en tant que package Python

www.altova.com Imprimer cette rubrique Page précédente Un niveau supérieur Page suivante

Accueil >  API de moteur : Python et .NET > Python API >

RaptorXML+XBRL Server en tant que package Python

Depuis RaptorXML+XBRL Server 2017, l'API Python est disponible en tant que package wheel Python natif pour Python 3.5.  Le package wheel Python peut être installé en tant que module d'extension dans votre distribution Python 3.5 préférée (par exemple, depuis python.org). Certaines distributions Python 3 (par exemple, provenant de jupyter.org, anaconda.org et SciPy.org) comprennent une palette étendue de modules d'extension pour les big data, les mathématiques, la science, l'ingénierie et les graphiques. Ces modules sont maintenant disponibles pour RaptorXML+XBRL Server sans qu'il soit nécessaire de générer ces modules spécifiquement pour RaptorXML+XBRL Server. Sinon, le package wheel fonctionne de la même manière que l'application RaptorXMLXBRL-python.exe qui est contenue dans RaptorXML+XBRL Server.

 

Note :le package wheel Python est un module d'extension natif Python 3.5 et il est compatible avec la version Python 3.5.

 

Note:le package wheel Python ne contient pas le Python API v1.

 

Note:Si vous effectuez une mise à jour de votre version de RaptorXML+XBRL Server, veuillez vous assurer de mettre à jour le package wheel Python dans votre environnement Python.

 

L'information nécessaire pour installer correctement le package RaptorXML+XBRL Server est indiquée dans les sections ci-dessous :

 

Nom du fichier wheel
Emplacement du fichier wheel
Installer un wheel avec pip
Le fichier root catalog
Le fichier de config JSON

 

Pour plus d'informations concernant l'utilisation de l'API Python de RaptorXML+XBRL Server, voir référence API Python et exemples. Voir aussi les scripts d'exemple qui utilisent l'API Python de Raptor sous https://github.com/altova.

 

Nom du fichier wheel

Les fichiers wheel sont nommés conformément au motif suivant :

 

raptorxmlserver-{version}(-{build tag})?-{python tag}-{abi tag}-{platform tag}.whl

 

Exemples :

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

raptorxmlserver-2.6.0-cp35-cp35m-win_amd64.whl

 

Emplacement du fichier wheel

Un fichier wheel est contenu avec votre installation de RaptorXML+XBRL Server. Il se trouve dans le dossier bin de l'application :

 

Windows

Program Files\Altova\RaptorXMLXBRLServer2019\bin

Linux

/opt/Altova/RaptorXMLXBRLServer2019/bin

Mac

/usr/local/Altova/RaptorXMLXBRLServer2019/bin

 

Installer un wheel avec pip

Pour installer le package RaptorXML+XBRL Server en tant que module Python, utiliser la commande pip :

 

pip install <wheel-file>.whl

python -m pip install <wheel-file>.whl  

 

Si vous avez installé Python 3.5 ou plus depuis python.org, alors pip sera déjà installé. Sinon, vous devrez tout d'abord installer pip. Pour plus d'informations, voir https://docs.python.org/3/installing/.

 

Le fichier de catalogue root

Le module RaptorXMLXBRL pour Python doit pouvoir situer RootCatalog.xml, le fichier de catalogue root qui est stocké dans votre dossier d'installation RaptorXML+XBRL Server. La raison est que le module RaptorXMLXBRL peut utiliser le catalogue pour situer correctement les différentes ressources, comme des schémas et d'autres spécifications, que le module référence pour pouvoir effectuer des fonctions comme des validations et des transformations. Le module RaptorXMLXBRL situera automatiquement RootCatalog.xml si l'emplacement du catalogue n'a pas été modifié après l'installation de RaptorXML+XBRL Server.

 

Au cas où vous déplacez ou modifiez votre environnement RaptorXML+XBRL Server, ou si vous déplacez RootCatalog.xml depuis son emplacement d'origine, vous pouvez spécifier l'emplacement du catalogue par le moyen des variables d'environnement et le fichier de configuration JSON  du module RaptorXMLXBRL. Voir la liste ci-dessous pour consulter les moyens se trouvant à votre disposition. Le module RaptorXMLXBRL détermine l'emplacement de RootCatalog.xml en consultant les ressources suivantes dans l'ordre donné.

 

 

1

Variable d'environnement ALTOVA_RAPTORXML_PYTHON_CATALOGPATH

Créer avec une valeur qui est le chemin vers RootCatalog.xml

2

Registre HKLM : SOFTWARE\Altova\RaptorXML+XBRLServer\Installation_v2019_x64\Setup\CatalogPath

La clé de registre est ajoutée par l'installateur RaptorXML+XBRL Server. La valeur est le chemin vers RootCatalog.xml. Uniquement Windows

3

Emplacement : /opt/Altova/RaptorXMLXBRLServer2019/etc/RootCatalog.xml

Uniquement Linux

4

Emplacement : /usr/local/Altova/RaptorXMLXBRLServer2019/etc/RootCatalog.xml

Uniquement Mac

5

Variable d'environnement ALTOVA_RAPTORXML_PYTHON_CONFIG

Créer avec une valeur qui est le chemin vers le fichier de config JSON.

6

Emplacement : .altova/raptorxml-python.config

Le fichier de config JSON dans le répertoire de travail actuel

7

Emplacement : ~/.config/altova/raptorxml-python.config

Le fichier de config JSON dans le répertoire home de l'utilisateur

8

Emplacement : /etc/altova/altova/raptorxml-python.config

Le fichier de config JSON. Uniquement Linux et Mac

 

Le fichier de config JSON

Vous pouvez créer un fichier de config JSON pour le module RaptorXMLXBRLServer. Ce fichier sera utilisé par les options 5 à 8 dans la table ci-dessus pour situer le fichier de catalogue root. Le fichier de config JSON doit contenir un map avec une clé "CatalogPath" qui a une valeur qui est le chemin vers le fichier de catalogue root.

 

Liste du fichier config JSON

 

{

    "CatalogPath": "/path/to/RootCatalog.xml"

}

 


© 2019 Altova GmbH