Installation

Le package est disponible sur PyPI et peut être installé via pip en exécutant la commande suivante :

pip install groupdocs-annotation-cloud

SDK Python d’annotation de documents Cloud

L’API GroupDocs.Annotation Cloud offre un SDK Python complet pour une annotation de documents fluide. Intégrez facilement des fonctionnalités telles que l’ajout de commentaires, de surlignages, de filigranes et de caviardages à divers formats de documents, notamment PDF, Word, Excel et PowerPoint, dans vos applications Python.

Annotations de documents

Annotations de texte - Ajoutez des commentaires ou des explications dans le texte.
Annotations de zone - Mettez en évidence des zones spécifiques d’un document pour des notes détaillées.
Annotations de point - Marquez des points d’intérêt spécifiques dans un document.
Annotations de flèche - Dirigez l’attention des lecteurs vers des éléments spécifiques à l’aide de marqueurs de flèche.
Annotations barrées/soulignées - Mettez en évidence le texte en le barrant ou en le soulignant pour une référence facile.

Fonctionnalités de balisage

Surlignage - Marquez les sections importantes du texte avec des surlignages.
Caviardage - Masquez ou censurez complètement le contenu sensible dans les documents.
Filigrane - Protégez les documents en ajoutant des filigranes pour indiquer la propriété.

Gestion des annotations

Modifier les annotations - Modifiez ou mettez à jour les annotations existantes dans les documents.
Supprimer les annotations - Supprimez les annotations inutiles ou obsolètes.
Exporter les annotations - Extrayez les annotations pour les stocker séparément ou les partager avec d’autres.

Fonctionnalités de collaboration

Commentaires - Activez la collaboration multi-utilisateurs avec des fonctionnalités de commentaires en fil de discussion.
Contrôle de version - Suivez les modifications apportées aux annotations avec des outils de versioning.
Mises à jour en temps réel - Implémentez des mises à jour lorsque plusieurs utilisateurs modifient le même document.

Fonctionnalités de sécurité

Contrôle d’accès - Sécurisez les annotations de documents avec un contrôle d’accès basé sur l’utilisateur.
Permissions basées sur les rôles - Attribuez différents niveaux d’autorisation aux utilisateurs pour protéger les annotations sensibles.
Chiffrement - Assurez-vous que les données sont chiffrées lors du transfert et du stockage des documents.

Fonctionnalités avancées

Combiner les annotations - Fusionnez plusieurs annotations en un seul document.
Annotations en couches - Manipulez les annotations en couches pour un caviardage et un marquage flexibles.
Styles d’annotation personnalisés - Définissez des couleurs, une opacité et une taille personnalisées pour les annotations.
Intégration API - Intégrez avec d’autres systèmes à l’aide d’API REST.
Infrastructure évolutive - Prend en charge les environnements à forte charge avec une architecture évolutive.

Types et fonctionnalités d’annotation pris en charge

Annotation de zone

• Marquez une zone de la page du document avec un rectangle.
  • Permet aux utilisateurs de mettre en évidence une région spécifique d’un document.
  • Les dimensions de la zone peuvent être personnalisées pour correspondre à la zone d’intérêt.
  • Prend en charge les réponses aux annotations pour les révisions collaboratives.
  • L’annotation de zone peut inclure des commentaires supplémentaires.

Annotation de distance

• Mesure la distance entre les objets d’un document.
  • Permet des mesures précises dans le contenu du document.
  • Les coordonnées et les dimensions peuvent être définies pour des mesures exactes.
  • Utile pour les documents d’architecture et d’ingénierie où les mesures de distance sont critiques.

Annotation elliptique

• Dessine des annotations elliptiques sur une page de document.
  • Permet aux utilisateurs de mettre en évidence des zones circulaires ou elliptiques.
  • Rayon, couleur et opacité personnalisables pour une visibilité claire.
  • Prend en charge plusieurs réponses pour des commentaires supplémentaires sur la zone marquée.

Annotation d’image

• Ajoute une image à une zone spécifique du document.
  • Insère des images dans une page de document pour référence visuelle.
  • Prend en charge le positionnement et le redimensionnement des images.
  • Utile pour ajouter des logos, des tampons ou des marques visuelles.

Annotation de lien

• Ajoute un hyperlien à un document.
  • Lie un texte ou des zones spécifiques du document à des URL externes.
  • Prend en charge la navigation web ou la référence à des ressources supplémentaires.
  • Peut être stylisé avec différentes couleurs pour se différencier du texte.

Annotations multiples

• Permet d’ajouter plusieurs types d’annotations simultanément.
  • Prend en charge l’ajout d’une combinaison d’annotations (par ex. texte, images, formes) en une seule fois.
  • Utile pour la révision de documents où différents types d’annotations sont nécessaires sur la même page.
  • Les annotations multiples peuvent être regroupées ou traitées séparément.

Annotation de point

• Attache des commentaires à un point spécifique du document.
  • Les commentaires sont associés à un point ou à un emplacement spécifique dans le document.
  • Idéal pour les révisions collaboratives de documents où il est nécessaire de cibler précisément les retours.
  • Prend en charge les ajustements de couleur et de taille pour une meilleure visibilité.

Annotation polyligne

• Dessine des lignes connectées pour former une polyligne dans un document.
  • Utilisé pour dessiner des formes complexes ou marquer des chemins spécifiques dans un document.
  • Prend en charge plusieurs points connectés par des lignes droites.
  • Permet la personnalisation de l’épaisseur, de la couleur et de l’opacité des lignes.

Annotation de caviardage de ressource

• Remplit un rectangle noir à une position fixe pour masquer des informations sensibles.
  • Caviarde efficacement les informations confidentielles des documents.
  • La zone noire peut être dimensionnée et positionnée sur toute donnée sensible.
  • Couramment utilisé pour les documents juridiques, les états financiers ou les numéros d’identification personnelle (PIN).

Annotation ondulée

• Ajoute un soulignement ondulé pour marquer le texte.
  • Met en évidence le texte avec un soulignement ondulé pour attirer l’attention.
  • Idéal pour marquer les erreurs d’orthographe ou de grammaire.
  • La couleur et le style de ligne peuvent être ajustés pour se différencier des autres annotations.

Formats d’annotation pris en charge

Démarrage avec le SDK Cloud GroupDocs.Annotation pour Python

Exigences

Python 2.7 ou 3.4+

Installation

Installez groupdocs-annotation-cloud avec PIP depuis PyPI :

pip install groupdocs-annotation-cloud

Ou clonez le dépôt et installez-le via Setuptools :

python setup.py install

Veuillez suivre la procédure d’installation, puis exécutez ce qui suit :

# Import module
import groupdocs_annotation_cloud

# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

# Create instance of the API
api = groupdocs_annotation_cloud.InfoApi.from_keys(app_sid, app_key)

try:
    # Retrieve supported file-formats
    response = api.get_supported_file_formats()

    # Print out supported file-formats
    print("Supported file-formats:")
    for format in response.formats:
        print('{0} ({1})'.format(format.file_format, format.extension))
except groupdocs_annotation_cloud.ApiException as e:
    print("Exception when calling get_supported_file_formats: {0}".format(e.message))

Modèles de données de l’API GroupDocs.Annotation Cloud

FilesUploadResult, Error, ErrorDetails, FilesList, StorageFile, StorageExist, ObjectExist, DiscUsage, FileVersions, FileVersion, AnnotationInfo, Rectangle, Point, AnnotationReplyInfo, FileInfo, AnnotationApiLink, Link, RemoveOptions, AnnotateOptions, FormatsResult, Format, DocumentInfo, PageInfo, ConsumptionResult, PageImages, PageImage, LinkElement, PreviewOptions

Exemple de code Python 1 : Ajouter une annotation de texte

Cet exemple de code montre comment ajouter une annotation de texte à un document à l’aide du SDK Cloud GroupDocs.Annotation pour Python. L’annotation de texte est personnalisable en termes de position, de police et de couleur.

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python-samples
import groupdocs_annotation_cloud
 
app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(app_sid, app_key)
 
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.font_color = 1201033
a1.font_size = 12
a1.opacity = 0.7
a1.type = "TextField"           
a1.text = "Text field text"
a1.creator_name = "Anonym A."
 
file_info = FileInfo()
file_info.file_path = "annotationdocs\\one-page.docx"
options = AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"
 
request = AnnotateRequest(options)
result = api.annotate(request)         
 
print("AddTextFieldAnnotation: Text Field Annotation added: " + result['href'])

Exemple de code Python 2 : Ajouter une annotation de zone

Cet exemple de code montre comment ajouter une annotation de zone (mise en évidence d’une section d’un document).

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python-samples
import groupdocs_annotation_cloud
 
app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(app_sid, app_key)
 
a1 = groupdocs_annotation_cloud.AnnotationInfo()
a1.annotation_position = groupdocs_annotation_cloud.Point()
a1.annotation_position.x = 1
a1.annotation_position.y = 1
a1.box = groupdocs_annotation_cloud.Rectangle()
a1.box.x = 100
a1.box.y = 100
a1.box.width = 200
a1.box.height = 100
a1.page_number = 0
a1.pen_color = 1201033
a1.pen_style = "Solid"
a1.pen_width = 1
a1.opacity = 0.7
a1.type = "Area"
a1.text = "This is area annotation"
a1.creator_name = "Anonym A."
 
file_info = FileInfo()
file_info.file_path = "annotationdocs\\one-page.docx"
options = AnnotateOptions()
options.file_info = file_info
options.annotations = [a1]
options.output_path = "Output\\output.docx"
 
request = AnnotateRequest(options)
result = api.annotate(request)         
 
print("AddAreaAnnotation: Area Annotation added: " + result['href'])

Exemple de code Python 3 : Supprimer une annotation

Cet exemple de code montre comment supprimer une annotation d’un document.

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python-samples
import groupdocs_annotation_cloud
 
app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(app_sid, app_key)
 
file_info = FileInfo()
file_info.file_path = "annotationdocs\\input.docx"
options = RemoveOptions()
options.file_info = file_info
options.annotation_ids = [1, 2, 3]
options.output_path = "Output\\output.docx"
 
request = RemoveAnnotationsRequest(options)
result = api.remove_annotations(request)
 
print("RemoveAnnotations: Annotations removed: " + result['href'])