Como fazer anotações em PDFs facilmente em Python usando o IronPDF

Pré-requisitos

Antes de começar a anotar PDFs usando o IronPDF, certifique-se de ter os seguintes pré-requisitos:

1. Python: Certifique-se de que o Python esteja instalado em seu computador. Para baixar a versão mais recente, visite o site oficial do Python.
2. Instale uma IDE: Antes de começar a trabalhar com seus PDFs usando o IronPDF, você precisará instalar uma IDE. O PyCharm é recomendado como um ambiente de desenvolvimento integrado (IDE) popular for Python. Alternativamente, você pode usar qualquer IDE de sua escolha, caso não queira usar o PyCharm.

3. Biblioteca IronPDF : Instale a biblioteca IronPDF usando o seguinte comando no terminal:

   pip install IronPDF

   pip install IronPDF

   SHELL

   Instale o pacote IronPDF

4. Ambiente de execução .NET 6.0: O IronPDF for Python depende da tecnologia .NET 6.0 para funcionar corretamente. Isso significa que você precisa ter o .NET 6.0 instalado no seu computador para usar o IronPDF for Python de forma eficaz. Muito provavelmente, ele será instalado automaticamente com as dependências do IronPDF no momento da execução do projeto.

Nota: Ao instalar o IronPDF usando o pip (Gerenciador de Pacotes do Python), é importante garantir que o caminho de instalação do IronPDF esteja incluído na variável PATH do sistema. Esta etapa é crucial para garantir que o pip consiga localizar o pacote IronPDF e seus componentes associados durante a instalação e utilização.

Passo 1: Importando a biblioteca IronPDF

A primeira linha importa os módulos necessários da biblioteca IronPDF , permitindo o acesso às classes e funções necessárias para manipulação e anotação de PDFs.

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

Etapa 2: Carregando um documento PDF existente

Nesta etapa, um arquivo PDF existente chamado "existing.pdf" é carregado usando a classe PdfDocument . Este documento será usado como base para adicionar anotações. Defina também o índice da página na qual os tipos de anotação compatíveis serão adicionados.

# Load the PDF document and set the target page index for annotation
pdf = PdfDocument("existing.pdf")
pageIndex = 0

# Load the PDF document and set the target page index for annotation
pdf = PdfDocument("existing.pdf")
pageIndex = 0

Etapa 3: Definir parâmetros de anotação

As linhas de código a seguir definem várias propriedades para anotações de texto que serão adicionadas ao PDF. Essas propriedades fornecem informações sobre a aparência e o comportamento da anotação:

# Create a text annotation and configure its properties
annotation = TextAnnotation(pageIndex)
annotation.Title = "This is the major title"
annotation.Subject = "This is a subtitle"
annotation.Contents = "This is the long 'sticky note' comment content..."
annotation.Icon = TextAnnotation.AnnotationIcon.Help
annotation.X = 150
annotation.Y = 200
annotation.Width = 200
annotation.Height = 50
annotation.Opacity = 0.9
annotation.Printable = False
annotation.Hidden = False
annotation.OpenByDefault = True
annotation.ReadOnly = False
annotation.Rotatable = True

# Create a text annotation and configure its properties
annotation = TextAnnotation(pageIndex)
annotation.Title = "This is the major title"
annotation.Subject = "This is a subtitle"
annotation.Contents = "This is the long 'sticky note' comment content..."
annotation.Icon = TextAnnotation.AnnotationIcon.Help
annotation.X = 150
annotation.Y = 200
annotation.Width = 200
annotation.Height = 50
annotation.Opacity = 0.9
annotation.Printable = False
annotation.Hidden = False
annotation.OpenByDefault = True
annotation.ReadOnly = False
annotation.Rotatable = True

Eis o que cada propriedade representa:

• Anotação: Configuração da variável de anotação e declaração do tipo de anotação.
• Título: O título principal da nova anotação.
• Assunto: Uma legenda ou informação adicional sobre a anotação.
• Conteúdo: O conteúdo principal da anotação assemelha-se a um comentário em um "post-it".
• Ícone: O ícone visual associado à anotação (neste caso, um ícone de ajuda).
• X e Y: As coordenadas do canto superior esquerdo da anotação na página.
• Largura e Altura: As dimensões da caixa delimitadora da anotação.
• Opacidade: O nível de opacidade da anotação (variando de 0 a 1).
• Imprimível: Indica se a anotação deve ser impressa.
• Oculto: Indica se a anotação está inicialmente oculta.
• OpenByDefault: Indica se a anotação deve estar aberta por padrão.
• Somente leitura: Indica se a anotação é somente para leitura.
• Rotativo: Indica se a anotação pode ser rotacionada.

Para mais tipos de anotações e propriedades, visite esta página de exemplos de código .

Etapa 4: Adicionando a anotação ao PDF

A seguinte linha de código adiciona a anotação de texto criada a uma página específica dentro do documento PDF:

# Add the text annotation to the specified page in the PDF document
pdf.Annotations.Add(annotation)

# Add the text annotation to the specified page in the PDF document
pdf.Annotations.Add(annotation)

Etapa 5: Salvar o PDF anotado

Por fim, o documento PDF atualizado com a anotação adicionada é salvo usando o método Salvar como :

# Save the PDF document with the new annotations
pdf.SaveAs("annotated.pdf")

# Save the PDF document with the new annotations
pdf.SaveAs("annotated.pdf")

Etapa 6: Executando o script

Agora, vamos juntar todo o código e executar o script no projeto PyCharm que foi criado anteriormente.

1. Para executar o script no PyCharm, clique com o botão direito do mouse em qualquer lugar dentro do editor de scripts e selecione Executar annotatePDF .
2. O PyCharm executará o script e você verá a saída e quaisquer erros potenciais no console "Executar" na parte inferior da IDE.
3. Após a conclusão do script, você encontrará o PDF anotado ("annotated.pdf") no mesmo diretório do seu projeto.

Saída:

O arquivo PDF de saída