Installation

Das Paket ist verfügbar bei PyPI und kann über pip mit folgendem Befehl installiert werden:

pip install groupdocs-annotation-cloud

Cloud-Dokumentannotation Python SDK

Die GroupDocs.Annotation Cloud API bietet ein umfassendes Python SDK für nahtlose Dokumentannotation. Integrieren Sie einfach Funktionen wie das Hinzufügen von Kommentaren, Hervorhebungen, Wasserzeichen und Schwärzungen zu verschiedenen Dokumentformaten, einschließlich PDF, Word, Excel und PowerPoint, in Ihren Python-Anwendungen.

Dokumentannotationen

Textannotationen - Fügen Sie Kommentare oder Erklärungen innerhalb des Textes hinzu.
Bereichsannotationen - Heben Sie bestimmte Bereiche eines Dokuments für detaillierte Notizen hervor.
Punktannotationen - Markieren Sie bestimmte Punkte von Interesse in einem Dokument.
Pfeilannotationen - Lenken Sie die Aufmerksamkeit der Betrachter mit Pfeilmarkierungen auf bestimmte Elemente.
Durchstreichungs-/Unterstreichungsannotationen - Heben Sie Text durch Durchstreichen oder Unterstreichen für eine einfache Referenz hervor.

Markup-Funktionen

Hervorhebung - Markieren Sie wichtige Textabschnitte mit Hervorhebungen.
Schwärzung - Verbergen oder zensieren Sie sensible Inhalte in Dokumenten vollständig.
Wasserzeichen - Schützen Sie Dokumente durch Hinzufügen von Wasserzeichen zur Kennzeichnung des Eigentums.

Annotationsverwaltung

Annotationen bearbeiten - Ändern oder aktualisieren Sie vorhandene Annotationen in Dokumenten.
Annotationen löschen - Entfernen Sie unnötige oder veraltete Annotationen.
Annotationen exportieren - Extrahieren Sie Annotationen, um sie separat zu speichern oder mit anderen zu teilen.

Kollaborationsfunktionen

Kommentieren - Ermöglichen Sie die Zusammenarbeit mehrerer Benutzer mit threadbasierten Kommentarfunktionen.
Versionskontrolle - Verfolgen Sie Änderungen an Annotationen mit Versionswerkzeugen.
Echtzeit-Updates - Implementieren Sie Updates, wenn mehrere Benutzer dasselbe Dokument bearbeiten.

Sicherheitsfunktionen

Zugriffskontrolle - Sichern Sie Dokumentannotationen mit benutzerbasierter Zugriffskontrolle.
Rollenbasierte Berechtigungen - Weisen Sie Benutzern unterschiedliche Berechtigungsstufen zu, um sensible Annotationen zu schützen.
Verschlüsselung - Stellen Sie sicher, dass Daten bei der Dokumentübertragung und -speicherung verschlüsselt sind.

Erweiterte Funktionen

Annotationen kombinieren - Führen Sie mehrere Annotationen in einem Dokument zusammen.
Mehrschichtige Annotationen - Bearbeiten Sie mehrschichtige Annotationen für flexible Schwärzung und Markierung.
Benutzerdefinierte Annotationsstile - Legen Sie benutzerdefinierte Farben, Deckkraft und Größe für Annotationen fest.
API-Integration - Integrieren Sie mit anderen Systemen über REST APIs.
Skalierbare Infrastruktur - Unterstützt Hochlastumgebungen mit skalierbarer Architektur.

Unterstützte Annotationsarten und -funktionen

Bereichsannotation

• Markieren Sie einen Bereich auf der Dokumentseite mit einem Rechteck.
  • Ermöglicht Benutzern, eine bestimmte Region in einem Dokument hervorzuheben.
  • Die Abmessungen des Rahmens können an den Bereich von Interesse angepasst werden.
  • Unterstützt Antworten auf Annotationen für kollaborative Reviews.
  • Die Bereichsannotation kann zusätzliche Kommentare enthalten.

Abstandsannotation

• Misst den Abstand zwischen Objekten in einem Dokument.
  • Ermöglicht präzise Messungen innerhalb des Dokumentinhalts.
  • Koordinaten und Abmessungen können für exakte Messungen definiert werden.
  • Nützlich für Architektur- und Ingenieurdokumente, bei denen Abstandsmessungen entscheidend sind.

Ellipsenannotation

• Zeichnet elliptische Annotationen auf einer Dokumentseite.
  • Ermöglicht Benutzern, kreisförmige oder elliptische Bereiche hervorzuheben.
  • Anpassbarer Radius, Farbe und Deckkraft für klare Sichtbarkeit.
  • Unterstützt mehrere Antworten für zusätzliche Kommentare zum markierten Bereich.

Bildannotation

• Fügt ein Bild zu einem bestimmten Bereich des Dokuments hinzu.
  • Fügt Bilder innerhalb einer Dokumentseite als visuelle Referenz ein.
  • Unterstützt Positionierung und Größenänderung von Bildern.
  • Nützlich zum Hinzufügen von Logos, Stempeln oder visuellen Markierungen.

Linkannotation

• Fügt einen Hyperlink zu einem Dokument hinzu.
  • Verknüpft bestimmten Text oder Bereiche des Dokuments mit externen URLs.
  • Bietet Unterstützung für Webnavigation oder Verweis auf zusätzliche Ressourcen.
  • Kann mit verschiedenen Farben gestaltet werden, um sich vom Text abzuheben.

Mehrfachannotation

• Ermöglicht das gleichzeitige Hinzufügen mehrerer Annotationsarten.
  • Unterstützt das Hinzufügen einer Kombination von Annotationen (z. B. Text, Bilder, Formen) auf einmal.
  • Nützlich für die Dokumentenprüfung, bei der verschiedene Annotationsarten auf derselben Seite benötigt werden.
  • Mehrere Annotationen können gruppiert oder separat behandelt werden.

Punktannotation

• Befestigt Kommentare an einem bestimmten Punkt im Dokument.
  • Kommentare sind mit einem bestimmten Punkt oder Ort innerhalb des Dokuments verknüpft.
  • Ideal für kollaborative Dokumentenreviews, bei denen präzises Feedback erforderlich ist.
  • Unterstützt Farb- und Größenanpassungen für bessere Sichtbarkeit.

Polylinienannotation

• Zeichnet verbundene Linien, um eine Polylinie in einem Dokument zu bilden.
  • Wird zum Zeichnen komplexer Formen oder Markieren bestimmter Pfade in einem Dokument verwendet.
  • Unterstützt mehrere Punkte, die durch gerade Linien verbunden sind.
  • Ermöglicht die Anpassung von Linienstärke, Farbe und Deckkraft.

Ressourcen-Schwärzungsannotation

• Füllt ein schwarzes Rechteck an einer festen Position, um sensible Informationen zu verbergen.
  • Schwärzt vertrauliche Informationen in Dokumenten effektiv.
  • Der schwarze Kasten kann über sensible Daten in beliebiger Größe positioniert werden.
  • Häufig verwendet für Rechtsdokumente, Finanzberichte oder persönliche Identifikationsnummern (PINs).

Wellenlinienannotation

• Fügt eine wellenförmige Unterstreichung hinzu, um Text zu markieren.
  • Hebt Text mit einer wellenförmigen Unterstreichung hervor, um Aufmerksamkeit zu erregen.
  • Ideal zum Markieren von Rechtschreib- oder Grammatikfehlern.
  • Farbe und Linienstil können angepasst werden, um sich von anderen Annotationen abzuheben.

Unterstützte Annotationsformate

Erste Schritte mit GroupDocs.Annotation Cloud Python SDK

Anforderungen

Python 2.7 oder 3.4+

Installation

Installieren Sie groupdocs-annotation-cloud mit PIP von PyPI:

pip install groupdocs-annotation-cloud

Oder klonen Sie das Repository und installieren Sie es über Setuptools:

python setup.py install

Bitte folgen Sie der Installationsanleitung und führen Sie anschließend Folgendes aus:

# 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))

GroupDocs.Annotation Cloud API-Datenmodelle

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

Python-Codebeispiel 1: Textannotation hinzufügen

Dieses Codebeispiel zeigt, wie Sie mit dem GroupDocs.Annotation Cloud SDK für Python eine Textannotation zu einem Dokument hinzufügen. Die Textannotation ist in Bezug auf Position, Schriftart und Farbe anpassbar.

# 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'])

Python-Codebeispiel 2: Bereichsannotation hinzufügen

Dieses Codebeispiel zeigt, wie Sie eine Bereichsannotation hinzufügen (Hervorhebung eines Abschnitts eines Dokuments).

# 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'])

Python-Codebeispiel 3: Annotation entfernen

Dieses Codebeispiel zeigt, wie Sie eine Annotation aus einem Dokument entfernen.

# 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'])