Comment annoter facilement des PDF en Python en utilisant IronPDF

Prérequis

Avant de plonger dans l'annotation de PDFs en utilisant IronPDF, assurez-vous d'avoir les prérequis suivants en place :

1. Python : Assurez-vous que Python est installé sur votre ordinateur. Pour télécharger la dernière version, visitez le site officiel de Python.
2. Installer un IDE : Avant de pouvoir commencer à travailler sur vos PDFs avec IronPDF, vous devrez installer un IDE. PyCharm est recommandé comme environnement de développement intégré (IDE) populaire pour Python. Alternativement, vous pouvez utiliser n'importe quel IDE de votre choix si vous ne souhaitez pas utiliser PyCharm.

3. Bibliothèque IronPDF : Installez la bibliothèque IronPDF en utilisant la commande suivante dans le terminal:

   pip install IronPDF

   pip install IronPDF

   SHELL

   Installer le package IronPDF

4. Runtime .NET 6.0 : IronPDF pour Python repose sur la technologie .NET 6.0 pour fonctionner correctement. Cela signifie que vous devez avoir le runtime .NET 6.0 installé sur votre ordinateur pour utiliser efficacement IronPDF pour Python. Il sera très probablement installé automatiquement avec les dépendances d'IronPDF lors de l'exécution du projet.

Note : Lors de l'installation d'IronPDF en utilisant pip (Gestionnaire de paquets Python), il est important de s'assurer que le chemin d'installation d'IronPDF est inclus dans la variable PATH du système. Cette étape est cruciale pour s'assurer que pip peut trouver le package IronPDF et ses composants associés lors de l'installation et de l'utilisation.

Étape 1 : Importer la bibliothèque IronPDF

La première ligne importe les modules requis de la bibliothèque IronPDF, permettant d'accéder aux classes et fonctions nécessaires à la manipulation et à l'annotation de PDF.

from ironpdf import PdfDocument, TextAnnotation

from ironpdf import PdfDocument, TextAnnotation

Étape 2 : Charger un document PDF existant

Dans cette étape, un fichier PDF existant nommé "existing.pdf" est chargé en utilisant la classe PdfDocument. Ce document sera utilisé comme base pour ajouter des annotations. Définissez également l'index de la page sur laquelle les types d'annotations pris en charge seront ajoutés.

# 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

Étape 3 : Définir les paramètres d'annotation

Les lignes de code suivantes définissent diverses propriétés pour l'annotation texte qui sera ajoutée au PDF. Ces propriétés fournissent des informations sur l'apparence et le comportement de l'annotation :

# 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

Voici ce que représente chaque propriété :

• Annotation : Configurer la variable d'annotation et déclarer le type d'annotation.
• Titre : Le titre principal de la nouvelle annotation.
• Sujet : Un sous-titre ou des informations supplémentaires sur l'annotation.
• Contenu : Le contenu principal de l'annotation, ressemble à un commentaire de "note collante".
• Icône : L'icône visuelle associée à l'annotation (dans ce cas, une icône d'aide).
• X et Y : Les coordonnées du coin supérieur gauche de l'annotation sur la page.
• Largeur et Hauteur : Les dimensions de la boîte englobante de l'annotation.
• Opacité : Le niveau d'opacité de l'annotation (allant de 0 à 1).
• Imprimable : Si l'annotation doit être imprimée.
• Caché : Si l'annotation est initialement cachée.
• OuvertParDéfaut : Si l'annotation doit être ouverte par défaut.
• LectureSeulement : Si l'annotation est en lecture seule.
• Rotatable : Si l'annotation peut être tournée.

Pour plus de types d'annotations et de propriétés, visitez cette page d'exemples de code.

Étape 4 : Ajouter l'annotation au PDF

La ligne de code suivante ajoute l'annotation texte créée à une page spécifique du document 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)

Étape 5 : Sauvegarder le PDF annoté

Enfin, le document PDF mis à jour avec l'annotation ajoutée est enregistré à l'aide de la méthode 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")

Étape 6 : Exécuter le script

Mettons maintenant tout le code ensemble et exécutons le script dans le projet PyCharm qui a été créé précédemment.

1. Pour exécuter le script dans PyCharm, cliquez droit n'importe où dans l'éditeur de script et sélectionnez Exécuter annotatePDF.
2. PyCharm exécutera le script, et vous verrez la sortie et d'éventuelles erreurs dans la console d'exécution en bas de l'IDE.
3. Une fois le script terminé, vous pouvez trouver le PDF annoté ("annotated.pdf") dans le même répertoire que votre projet.

Sortie :

Le fichier PDF de sortie