Instalación

El paquete es available en pypi.org y se puede instalar a través de pip ejecutando el siguiente comando:

pip install groupdocs-annotation-cloud

SDK para Python para anotación de documentos en la nube

GroupDocs.Annotation Cloud API ofrece una completa Python SDK para realizar anotaciones de documentos sin problemas. Integre fácilmente funcionalidades como agregar comentarios, resaltados, marcas de agua y redacciones a varios formatos de documentos, incluidos PDF, Word, Excel y PowerPoint, dentro de sus aplicaciones Python.

Anotaciones de documentos

Anotaciones de texto: agregue comentarios o explicaciones dentro del texto.
Anotaciones de área: resalte áreas específicas de un documento para obtener notas detalladas.
Anotaciones de puntos: marca puntos de interés específicos en un documento.
Anotaciones de flecha: dirige la atención de los espectadores a elementos específicos con marcadores de flecha.
Anotaciones tachadas/subrayadas: resalte el texto tachándolo o subrayando para facilitar la referencia.

Funciones de marcado

Resaltado: marca secciones importantes del texto con resaltados.
Redacción: oculta o censura por completo el contenido confidencial de los documentos.
Marcas de agua: proteja los documentos agregando marcas de agua para indicar la propiedad.

Gestión de anotaciones

Editar anotaciones: modifica o actualiza las anotaciones existentes en los documentos.
Eliminar anotaciones: elimina anotaciones innecesarias u obsoletas.
Exportar anotaciones: extraiga anotaciones para almacenarlas por separado o compartirlas con otros.

Funciones de colaboración

Comentarios: habilite la colaboración multiusuario con funciones de comentarios basados ​​en hilos.
Control de versiones: realice un seguimiento de los cambios realizados en las anotaciones con herramientas de control de versiones.
Actualizaciones en tiempo real: implemente actualizaciones cuando varios usuarios editen el mismo documento.

Funciones de seguridad

Control de acceso: anotaciones seguras en documentos con control de acceso basado en el usuario.
Permisos basados ​​en roles: asigne diferentes niveles de permisos a los usuarios para proteger las anotaciones confidenciales.
Cifrado: asegúrese de que los datos estén cifrados durante la transferencia y el almacenamiento de documentos.

Funciones avanzadas

Combinar anotaciones: combine varias anotaciones en un solo documento.
Anotaciones en capas: manipule anotaciones en capas para redactar y marcar de manera flexible.
Estilos de anotación personalizados: establezca colores, opacidad y tamaño personalizados para las anotaciones.
Integración de API: integre con otros sistemas mediante API REST.
Infraestructura escalable: admite entornos de alta carga con arquitectura escalable.

Tipos de anotaciones y características admitidas

Anotación de área

• Marque un área dentro de la página del documento con un rectángulo.
  • Permite a los usuarios resaltar una región específica en un documento.
  • Las dimensiones de la caja se pueden personalizar para adaptarse al área de interés.
  • Admite respuestas a anotaciones para revisiones colaborativas.
  • La anotación del área puede incluir comentarios adicionales.

Anotación de distancia

• Mide la distancia entre objetos en un documento.
  • Permite mediciones precisas dentro del contenido del documento.
  • Se pueden definir coordenadas y dimensiones para medidas exactas.
  • Útil para documentos de arquitectura e ingeniería donde las medidas de distancia son críticas.

Anotación de elipse

• Dibuja anotaciones elípticas en una página de documento.
  • Permite a los usuarios resaltar áreas circulares o elípticas.
  • Radio, color y opacidad personalizables para una visibilidad clara.
  • Admite múltiples respuestas para comentarios agregados en el área marcada.

Anotación de imagen

• Agrega una imagen a un área específica del documento.
  • Inserta imágenes dentro de una página de documento para referencia visual.
  • Admite posicionamiento y cambio de tamaño de imágenes.
  • Útil para agregar logotipos, sellos o marcas visuales.

Anotación de enlace

• Agrega un hipervínculo a un documento.
  • Vincula texto o áreas específicas del documento a URL externas.
  • Proporciona soporte para la navegación web o referencia a recursos adicionales.
  • Se puede diseñar con diferentes colores para diferenciarlo del texto.

Anotación múltiple

• Permite agregar múltiples tipos de anotaciones simultáneamente.
  • Admite agregar una combinación de anotaciones (por ejemplo, texto, imágenes, formas) a la vez.
  • Útil para revisar documentos donde se necesitan diferentes tipos de anotaciones en la misma página.
  • Se pueden agrupar o tratar varias anotaciones por separado.

Anotación de puntos

• Pega comentarios a un punto específico del documento.
  • Los comentarios están asociados con un punto o ubicación específica dentro del documento.
  • Ideal para revisiones colaborativas de documentos donde es necesario identificar comentarios.
  • Admite ajustes de color y tamaño para una mejor visibilidad.

Anotación de polilínea

• Dibuja líneas conectadas para formar una polilínea en un documento.
  • Se utiliza para dibujar formas complejas o marcar rutas específicas en un documento.
  • Admite múltiples puntos conectados por líneas rectas.
  • Permite personalizar el grosor, el color y la opacidad de la línea.

Anotación de redacción de recursos

• Rellena un rectángulo negro en una posición fija para ocultar información confidencial.
  • Elimina eficazmente información confidencial de los documentos.
  • La caja negra se puede dimensionar y colocar sobre cualquier dato confidencial.
  • Comúnmente utilizado para documentos legales, estados financieros o números de identificación personal (PIN).

Anotación ondulada

• Agrega un subrayado ondulado para marcar el texto.
  • Resalta el texto con un subrayado ondulado para llamar la atención.
  • Ideal para marcar errores ortográficos o gramaticales.
  • El color y el estilo de línea se pueden ajustar para diferenciarlos de otras anotaciones.

Formatos de anotación admitidos

Primeros pasos GroupDocs.Annotation Cloud Python SDK

Requisitos

Python 2.7 o 3.4+

Instalación

Instalar groupdocs-annotation-cloudcon PIP de PyPI by:

pip install groupdocs-annotation-cloud

O clonar repository e instálelo a través de Setuptools:

python setup.py install

Siga el procedimiento de instalación y luego ejecute lo siguiente:

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

Modelos de datos de API de nube de GroupDocs.Annotation

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

Ejemplo 1 de código Python: agregar anotaciones de texto

Este ejemplo de código demuestra cómo agregar una anotación de texto a un documento usando GroupDocs.Annotation Cloud SDK para Python. La anotación de texto se puede personalizar en términos de posición, fuente y color.

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

Ejemplo 2 de código Python: Agregar anotación de área

Este ejemplo de código demuestra cómo agregar una anotación de área (resaltando una sección de un documento).

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

Ejemplo 3 de código Python: eliminar anotación

Este ejemplo de código demuestra cómo eliminar una anotación de un documento.

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