Documentation

Tout ce que vous faites dans Arvest peut aussi se faire depuis du code : Arvest repose sur une API REST ouverte. Utilisez le package Python pour vos scripts et notebooks, ou appelez l'API directement depuis n'importe quel langage. Les exemples ci-dessous peuvent être copiés tels quels ; remplacez l'adresse et le mot de passe par les vôtres.

01 Installation

Le package demande Python 3.9 ou plus récent. Installez-le directement depuis GitHub :

pip install git+https://github.com/ARVEST-APP/arvest-api.git

02 Se connecter

Connectez-vous avec l'adresse et le mot de passe de votre compte Arvest. Gardez-les hors de votre code, par exemple dans des variables d'environnement.

connect.py
import os
import arvestapi

ar = arvestapi.Arvest(
    os.environ["ARVEST_EMAIL"],
    os.environ["ARVEST_PASSWORD"],
)

print(f"Connected as {ar.profile.name}")

03 Projets

Listez vos projets, créez-en un, renommez-le ou supprimez-le.

projects.py
for project in ar.get_projects():
    print(project.id, project.title)

project = ar.create_project(title="Rehearsal notes")
project.update_title("Rehearsal notes, week 2")
project.update_description("Videos and annotations from the second week.")

# project.remove()

04 Médias

Ajoutez images, vidéos, sons ou documents, depuis votre ordinateur ou depuis un lien. Arvest donne à chacun une adresse utilisable dans les manifestes.

media.py
# from a file on your computer
photo = ar.add_media(path="photos/stage_plan.jpg")

# or from a link
video = ar.add_media(path="https://example.org/rehearsal.mp4")

print(photo.title, photo.get_full_url())

for media in ar.get_medias():
    print(media.id, media.title)

05 Manifestes IIIF

Importez un manifeste IIIF d'une bibliothèque ou d'une archive, ou envoyez le vôtre ; puis lisez et modifiez son JSON.

manifests.py
manifest = ar.add_manifest(
    path="https://iiif.bodleian.ox.ac.uk/iiif/manifest/e32a277e-91e2-4a6d-8ba6-cc4bad230410.json"
)

content = manifest.get_content()
content["label"] = {"en": ["Programme, 1978"]}
manifest.update_content(content)

print(manifest.get_full_url())

06 Métadonnées

Chaque élément a des métadonnées dans un format (Dublin Core par défaut). Lisez-les, remplissez des champs ou définissez votre propre format.

metadata.py
media = ar.get_medias()[0]
print(media.get_metadata())

media.update_metadata({"creator": "Pina Bausch", "date": "1978"})

# a format of your own
fmt = ar.create_metadata_format("Rehearsals", [
    {"term": "scene", "label": "Scene", "definition": "The scene shown."},
    {"term": "take", "label": "Take", "definition": "Which take."},
])
media.update_metadata({"scene": "3", "take": "2"}, metadata_format=fmt)

07 Exporter un espace de travail

L'espace de travail d'un projet (ses documents, leurs places, groupes, liens et annotations) est un seul document JSON. Enregistrez-le pour l'analyser ailleurs.

export_workspace.py
import json

project = next(p for p in ar.get_projects() if p.title == "Rehearsal notes")

with open("workspace.json", "w", encoding="utf-8") as f:
    json.dump(project.user_workspace.to_dict(), f, ensure_ascii=False, indent=2)

08 L'API REST directement

Sans le package : connectez-vous sur /auth/login pour obtenir un jeton, puis envoyez-le dans un en-tête Bearer. Chaque endpoint est décrit dans la référence Swagger.

rest.py
import os
import requests

API = "https://api.arvest.app"

login = requests.post(f"{API}/auth/login", json={
    "mail": os.environ["ARVEST_EMAIL"],
    "password": os.environ["ARVEST_PASSWORD"],
})
login.raise_for_status()
headers = {"Authorization": f"Bearer {login.json()['access_token']}"}

profile = requests.get(f"{API}/auth/profile", headers=headers).json()
print(profile)
rest.sh
TOKEN=$(curl -s -X POST https://api.arvest.app/auth/login \
  -H "Content-Type: application/json" \
  -d "{\"mail\": \"$ARVEST_EMAIL\", \"password\": \"$ARVEST_PASSWORD\"}" \
  | python3 -c "import sys, json; print(json.load(sys.stdin)['access_token'])")

curl -s https://api.arvest.app/auth/profile -H "Authorization: Bearer $TOKEN"

Plus d'exemples dans le dépôt du package ↗