Instalação

O pacote é disponível em pypi.org e pode ser instalado via pip executando o seguinte comando:

pip install groupdocs-annotation-cloud

Cloud Anotação de documento Python SDK

GroupDocs.Annotation Cloud API oferece um Python SDK abrangente para anotação contínua de documentos. Integre facilmente funcionalidades como adição de comentários, destaques, marcas d’água e redações a vários formatos de documentos, incluindo PDF, Word, Excel e PowerPoint, em seus aplicativos Python.

Anotações de documentos

Anotações de texto - Adicione comentários ou explicações ao texto.
Anotações de área - Destaque áreas específicas de um documento para obter notas detalhadas.
Anotações de pontos - Marque pontos de interesse específicos em um documento.
Anotações de setas: direcione a atenção dos espectadores para elementos específicos com marcadores de setas.
Anotações riscadas/sublinhadas - Destaque o texto tachando ou sublinhando para facilitar a referência.

Recursos de marcação

Destaque - Marque seções importantes do texto com destaques.
Edição - Oculte ou censure completamente o conteúdo confidencial dos documentos.
Marca d’água - Proteja documentos adicionando marcas d’água para indicar propriedade.

Gerenciamento de anotações

Editar anotações - Modifique ou atualize anotações existentes em documentos.
Excluir anotações - Remova anotações desnecessárias ou desatualizadas.
Exportar anotações - Extraia anotações para armazenar separadamente ou compartilhar com outras pessoas.

Recursos de colaboração

Comentários – Habilite a colaboração multiusuário com recursos de comentários baseados em threads.
Controle de versão – Acompanhe as alterações feitas nas anotações com ferramentas de controle de versão.
Atualizações em tempo real – Implemente atualizações quando vários usuários editarem o mesmo documento.

Recursos de segurança

Controle de acesso - Proteja anotações de documentos com controle de acesso baseado no usuário.
Permissões baseadas em funções – Atribua diferentes níveis de permissão aos usuários para proteger anotações confidenciais.
Criptografia – Garanta que os dados sejam criptografados durante a transferência e armazenamento de documentos.

Recursos avançados

Combinar anotações - Mesclar várias anotações em um documento.
Anotações em camadas - Manipule anotações em camadas para redação e marcação flexíveis.
Estilos de anotação personalizados - Defina cores, opacidade e tamanho personalizados para anotações.
Integração API - Integre-se com outros sistemas usando APIs REST.
Infraestrutura Escalável – Suporta ambientes de alta carga com arquitetura escalável.

Tipos e recursos de anotação suportados

Anotação de área

• Marque uma área na página do documento com um retângulo.
  • Permite aos usuários destacar uma região específica em um documento.
  • As dimensões da caixa podem ser personalizadas de acordo com a área de interesse.
  • Suporta respostas a anotações para revisões colaborativas.
  • A anotação da área pode incluir comentários adicionais.

Anotação de distância

• Mede a distância entre objetos em um documento.
  • Permite medições precisas no conteúdo do documento.
  • Coordenadas e dimensões podem ser definidas para medições exatas.
  • Útil para documentos de arquitetura e engenharia onde as medidas de distância são críticas.

Anotação de elipse

• Desenha anotações elípticas em uma página de documento.
  • Permite aos usuários destacar áreas circulares ou elípticas.
  • Raio, cor e opacidade personalizáveis ​​para visibilidade nítida.
  • Suporta múltiplas respostas para comentários adicionados na área marcada.

Anotação de imagem

• Adiciona uma imagem a uma área específica do documento.
  • Insere imagens em uma página de documento para referência visual.
  • Suporta posicionamento e redimensionamento de imagens.
  • Útil para adicionar logotipos, carimbos ou marcas visuais.

Anotação de link

• Adiciona um hiperlink a um documento.
  • Vincula textos ou áreas específicas do documento a URLs externos.
  • Fornece suporte para navegação na web ou referência a recursos adicionais.
  • Pode ser estilizado com cores diferentes para diferenciar do texto.

Anotação Múltipla

• Permite adicionar vários tipos de anotações simultaneamente.
  • Suporta a adição de uma combinação de anotações (por exemplo, texto, imagens, formas) de uma só vez.
  • Útil para revisar documentos onde são necessários diferentes tipos de anotação na mesma página.
  • Várias anotações podem ser agrupadas ou tratadas separadamente.

Anotação de ponto

• Fixa comentários em um ponto específico do documento.
  • Os comentários estão associados a um ponto ou local específico do documento.
  • Ideal para revisões colaborativas de documentos onde é necessário identificar feedback.
  • Suporta ajustes de cor e tamanho para melhor visibilidade.

Anotação de polilinha

• Desenha linhas conectadas para formar uma polilinha em um documento.
  • Usado para desenhar formas complexas ou marcar caminhos específicos em um documento.
  • Suporta vários pontos conectados por linhas retas.
  • Permite a personalização da espessura, cor e opacidade da linha.

Anotação de redação de recursos

• Preenche um retângulo preto em uma posição fixa para ocultar informações confidenciais.
  • Edita efetivamente informações confidenciais de documentos.
  • A caixa preta pode ser dimensionada e posicionada sobre quaisquer dados confidenciais.
  • Comumente usado para documentos legais, demonstrações financeiras ou números de identificação pessoal (PINs).

Anotação ondulada

• Adiciona um sublinhado ondulado para marcar o texto.
  • Destaca o texto com um sublinhado ondulado para chamar a atenção.
  • Ideal para marcar erros ortográficos ou gramaticais.
  • A cor e o estilo da linha podem ser ajustados para diferenciar de outras anotações.

Formatos de anotação suportados

Primeiros passos GroupDocs.Annotation Cloud Python SDK

Requisitos

Python 2.7 ou 3.4+

Instalação

Instale groupdocs-annotation-cloud com PIP de PyPI por:

pip install groupdocs-annotation-cloud

Ou clone repository e instale-o via Setuptools:

python setup.py install

Siga o procedimento de instalação e execute o seguinte:

# 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 Modelos de dados

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

Exemplo de código Python 1: adicionar anotação de texto

Este exemplo de código demonstra como adicionar uma anotação de texto a um documento usando GroupDocs.Annotation Cloud SDK para Python. A anotação de texto é personalizável em termos de posição, fonte e cor.

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

Exemplo de código Python 2: adicionar anotação de área

Este exemplo de código demonstra como adicionar uma anotação de área (destacando uma seção de um 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'])

Exemplo de código Python 3: remover anotação

Este exemplo de código demonstra como remover uma anotação de um 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'])