You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Michaël Costa f93d1b6998 Increment version [CI SKIP] 3 weeks ago
scrippy_api feat: Client can download files 3 weeks ago
tests feat: Client can download files 3 weeks ago
.bumpversion.cfg Increment version [CI SKIP] 3 weeks ago
.drone.yml chore: Remove all refs to GNC 2 months ago
.editorconfig Various config files 4 months ago
.flake8 Various config files 4 months ago
.gitignore chore: First Jenkins build 4 months ago
.pylintrc Various config files 4 months ago
.yamllint Various config files 4 months ago
CONTRIBUTING.md chore: Remove all refs to GNC 2 months ago
LICENSE Various config files 4 months ago
Makefile chore: Remove all refs to GNC 2 months ago
README.md Increment version [CI SKIP] 3 weeks ago
requirements.txt fix: requests version for RHEL 6 4 months ago
scrippy-api.png chore: First Jenkins build 4 months ago
setup.cfg Increment version [CI SKIP] 3 weeks ago
setup.py Various config files 4 months ago

README.md

version pylint Build Status License Language

Scrippy, mon ami le scrangourou

scrippy_api

Client d'API ReST pour le cadriciel Scrippy.

Avertissement

Ce dépôt est un dépôt public librement distribué y compris sur Internet. Le code qu'il contient ainsi que l'ensemble des configurations et documentations ne doit pas contenir d'informations sensibles telles que, et sans se limiter à, mots de passe et clefs privées.

Prérequis

Modules Python

Liste des modules nécessaires

  • requests
  • PyYAML
  • jsonschema

Installation

Manuelle

git clone https://git.mcos.nc/scrippy/scrippy-api.git
cd scrippy-api.git
sudo python3 -m pip install -r requirements.txt
make install

Avec pip

sudo pip3 install scrippy-api

Utilisation

Le module scrippy_api.api fournit l'objet Client permettant d'interroger n'importe quelle API REST de manière uniforme à l'aide de l'unique méthode Client.request().

L'objet Client dispose d'une unique méthode Client.request() qui accepte de nombreux paramètres dont la plupart sont optionnels. Cependant certains paramètres optionnels peuvent devenir obligatoires en fonction de la méthode HTTP utilisée pour la requête et du cas d'utilisation. YMMV.

La méthode Client.request() renvoie systématiquement un objet requests.Response (voir la documentation) qui devra être traité par le script.

Les clefs comme les valeurs des paramètres seront automatiquement encodés lorsque nécessaire.

En cas d'erreur (code HTTP != 200), le client sort avec un code retour 1 et l'erreur est enregistrée dans le journal comme critical. Ce comportement peut être inhibé lors de l'instanciation du client en positionnant le paramètre exit_on_error à False:

from scrippy_api.api import Client
client = Client(exit_on_error=False)

Dans ce cas les éventuelles erreurs rencontrées apparaîtront dans le fichier de journalisation comme warning.

Paramètres

Paramètre Type Utilité Valeur par défaut
params Dictionnaire Applicable à toutes les méthodes HTTP. Chacune des paires clef/valeur sera concaténée à l'URL. None
cookies Dictionnaire Les cookies à envoyer avec la requête None
timeout Entier Délai d'attente avant d'interrompre la connexion None
headers Dictionnaire Entêtes à envoyer avec la requête None
proxies Liste Liste des serveurs mandataires à utiliser pour la connexion None
auth Tuple Nom d'utilisateur et mot de passe pour l'authentification BASIC AUTH
data Dictionnaire Données à envoyer avec la requête. Non applicable avec la méthode GET None
json Dictionnaire Données au format JSON à envoyer avec la requête. Non applicable a la méthode GET. Utilisable lorsque data et file ne sont pas spécifiés None
files Dictionnaire Les fichiers à téléverser en multipart. Le dictionnaire prend la forme {<nom fichier>: <fichier>} None
verify Booléen/String Vérifie permet la vérification du certificat SSL. Si vérify est positionnée à False aucune vérification n'est effectuée. verify accepte également une chaîne de caractères qui doit être soit le nom d'un fichier certificat soit le nom d'un répertoire qui contient les certificats. True

Méthodes HTTP implémentées:

Méthode HTTP Utilité
GET Récupérer une ressource ou une liste d'URI de ressources
POST Créer une ressource
PUT Remplacer ou créer une ressource
PATCH Met à jour une ressource ou la créer si inexistante
DELETE Supprimer une ressource

Exemples

URL avec paramètres
from scrippy_api.api import Client
params = {"name": "Luiggi Vercotti", "password": "dead/parrot"}
client = Client()
response = client.request(method="GET", url="https://montypython.org/user", params=params)

L'URL appelée sera

https https://montypython.org/user?name=Luiggi+Vercotti&password=dead%2Fparrot
Authentification de base (BASIC AUTH)

Authentification de base à l'aide des identifiants suivants:

  • Utilisateur: Luiggi Vercotti
  • Mot de passe: dead/parrot
from scrippy_api.api import Client
auth = ("Luiggi Vercotti", "dead/parrot")
client = Client()
response = client.request(method="POST", url="https://montypython.org", auth=auth)
Envoi de données

Création de l'utilisateur Luiggi Vercotti dont le mot de passe est dead/parrot:

from scrippy_api.api import Client
data = {"name": "Luiggi Vercotti", "password": "dead/parrot"}
client = Client()
response = client.request(method="POST", url="https://montypython.org/user", data=data)
Téléversement de fichiers

Téléversement des deux fichiers ./images/dead_parrot.png et ./images/flying_circus.mp4:

from scrippy_api.api import Client
files = {"dead_parrot.png": open("./images/dead_parrot.png", "rb"), "flying_circus.mp4": open("./images/flying_circus.mp4", "rb")}
client = Client()
response = client.request(method="POST", url="https://montypython.org/upload", data=data)
Modification de ressource

Remplacement du mot de passe de l'utilisateur Luiggi Vercotti

from scrippy_api.api import Client
auth = ("Luiggi Vercotti", "dead/parrot")
data = {"password": "live/parrot"}
params = {"name": "Luiggi Vercotti"}
client = Client()
response = client.request(method="PATCH",
                          url="https://montypython.org/user",
                          params=params,
                          data=data)
Téléchargement de fichiers
from scrippy_api.api import Client
url = "https://monthy.python/inquisition.zip"
local_dir = "/home/luiggi.vercotti"
local_filename = "spanish_inquisition.zip"
client = Client()
if client.download(url, local_dir, local_filename):
  print("No one expects the Spanish inquisition")