Cómo Anotar Fácilmente PDFs en Python Usando IronPDF

Prerrequisitos

Antes de profundizar en la anotación de PDFs utilizando IronPDF, asegúrate de tener los siguientes requisitos previos:

1. Python: Asegúrate de que Python esté instalado en tu computadora. Para descargar la última versión, visita el sitio web oficial de Python.
2. Instalar un IDE: Antes de que puedas comenzar a trabajar con tus PDFs con IronPDF, necesitarás instalar un IDE. Se recomienda PyCharm como un entorno de desarrollo integrado (IDE) popular para Python. Alternativamente, puedes usar cualquier IDE de tu elección si no deseas usar PyCharm.

3. Biblioteca IronPDF: Instala la biblioteca IronPDF usando el siguiente comando en la terminal:

   pip install IronPDF

   pip install IronPDF

   SHELL

   Instalar el paquete IronPDF

4. .NET 6.0 Runtime: IronPDF para Python depende de la tecnología .NET 6.0 para funcionar correctamente. Esto significa que necesitas tener .NET 6.0 runtime instalado en tu computadora para usar IronPDF para Python efectivamente. Es muy probable que se instale automáticamente con las dependencias de IronPDF en el momento de la ejecución del proyecto.

Nota: Al instalar IronPDF usando pip (Python Package Manager), es importante asegurarse de que la ruta de instalación de IronPDF esté incluida en la variable PATH del sistema. Este paso es crucial para garantizar que pip pueda localizar el paquete IronPDF y sus componentes asociados durante la instalación y uso.

Paso 1: Importar la biblioteca IronPDF

La primera línea importa los módulos necesarios de la biblioteca IronPDF, permitiendo el acceso a las clases y funciones necesarias para la manipulación y anotación de PDFs.

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

Paso 2: Cargar un documento PDF existente

En este paso, se carga un archivo PDF existente llamado "existing.pdf" usando la clase PdfDocument. Este documento se utilizará como base para añadir anotaciones. Además, establece el índice de la página en la que se agregarán los tipos de anotación soportados.

# 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

Paso 3: Configuración de los parámetros de anotación

Las siguientes líneas de código definen varias propiedades para la anotación de texto que se añadirá al PDF. Estas propiedades proporcionan información sobre la apariencia y el comportamiento de la anotación:

# 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

Esto es lo que representa cada propiedad:

• Anotación: Configuración de la variable de anotación y declaración del tipo de anotación.
• Título: El título principal de la nueva anotación.
• Asunto: Un subtítulo o información adicional sobre la anotación.
• Contenido: El contenido principal de la anotación se asemeja a un comentario de "nota adhesiva".
• Icono: El icono visual asociado con la anotación (en este caso, un icono de ayuda).
• X e Y: Las coordenadas de la esquina superior izquierda de la anotación en la página.
• Ancho y Alto: Las dimensiones del cuadro delimitador de la anotación.
• Opacidad: el nivel de opacidad de la anotación (de 0 a 1).
• Imprimible: si la anotación debe imprimirse.
• Oculto: si la anotación está oculta inicialmente.
• OpenByDefault: si la anotación debe estar abierta de forma predeterminada.
• Sólo lectura: si la anotación es de sólo lectura.
• Rotatorio: si la anotación se puede rotar.

Para más tipos de anotaciones y propiedades visita esta página de ejemplos de código.

Paso 4: Añadir la anotación al PDF

La siguiente línea de código añade la anotación de texto creada a una página específica dentro del 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)

Paso 5: Guardar el PDF anotado

Finalmente, el documento PDF actualizado con la anotación añadida se guarda usando el método SaveAs:

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

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

Paso 6: Ejecutar el script

Ahora, pongamos todo el código junto y ejecutemos el script en el proyecto PyCharm que se creó anteriormente.

1. Para ejecutar el script dentro de PyCharm, haz clic derecho en cualquier lugar dentro del editor de scripts y selecciona Ejecutar annotatePDF.
2. PyCharm ejecutará el script, y verás la salida y cualquier error potencial en la consola de Ejecución en la parte inferior del IDE.
3. Una vez completado el script, puedes encontrar el PDF anotado ("annotated.pdf") en el mismo directorio que tu proyecto.

Salida:

El archivo PDF de salida