Установка

Пакет доступен на pypi.org и его можно установить через pip, выполнив следующую команду:

pip install groupdocs-annotation-cloud

SDK Python для аннотаций облачных документов

GroupDocs.Annotation Cloud API предлагает комплексный Python SDK для комплексного аннотирования документов. Легко интегрируйте в свои приложения Python такие функции, как добавление комментариев, выделения, водяных знаков и исправлений в различные форматы документов, включая PDF, Word, Excel и PowerPoint.

Аннотации к документу

Текстовые аннотации - Добавляйте комментарии или пояснения в тексте.
Аннотации к областям - Выделите определенные области документа для получения подробных примечаний.
Аннотации точек - Отмечайте в документе конкретные моменты, представляющие интерес.
Аннотации со стрелками - Направьте внимание зрителей на определенные элементы с помощью маркеров со стрелками.
Зачеркивание/подчеркивание аннотаций - Для удобства выделите текст, зачеркнув или подчеркнув его.

Возможности разметки

Выделение - Выделяйте важные разделы текста выделением.
Редакция - Полностью скрывайте или подвергайте цензуре конфиденциальный контент в документах.
Водяные знаки - Защитите документы, добавив водяные знаки, обозначающие право собственности.

Управление аннотациями

Изменить аннотации - Измените или обновите существующие аннотации в документах.
Удалить аннотации - Удалите ненужные или устаревшие аннотации.
Экспорт аннотаций - Извлекайте аннотации, чтобы хранить их отдельно или делиться ими с другими.

Возможности совместной работы

Комментирование - Обеспечьте многопользовательскую совместную работу с помощью функций комментирования на основе цепочек.
Контроль версий - Отслеживайте изменения, внесенные в аннотации, с помощью инструментов управления версиями.
Обновления в реальном времени - Внедряйте обновления, когда несколько пользователей редактируют один и тот же документ.

Функции безопасности

Контроль доступа - Защитите аннотации к документам с помощью пользовательского контроля доступа.
Разрешения на основе ролей - Назначайте пользователям разные уровни разрешений для защиты конфиденциальных аннотаций.
Шифрование - Обеспечьте шифрование данных во время передачи и хранения документов.

Расширенные функции

Объединить аннотации - Объединение нескольких аннотаций в один документ.
Многослойные аннотации - Управляйте многоуровневыми аннотациями для гибкого редактирования и маркировки.
Пользовательские стили аннотаций - Установите собственные цвета, непрозрачность и размер для аннотаций.
Интеграция API - Интегрируйтесь с другими системами с помощью REST API.
Масштабируемая инфраструктура - Поддерживает высоконагруженные среды с масштабируемой архитектурой.

Поддерживаемые типы и функции аннотаций

Аннотация области

• Отметьте область на странице документа прямоугольником.
• Позволяет пользователям выделять определенную область документа.
• Размеры коробки можно настроить в соответствии с интересующей областью.
• Поддерживает ответы на аннотации для совместных рецензий.
• Аннотация области может включать дополнительные комментарии.

Аннотация расстояния

• Измеряет расстояние между объектами в документе.
• Обеспечивает точные измерения содержимого документа.
• Координаты и размеры могут быть определены для точных измерений.
• Полезно для архитектурных и инженерных документов, где меры расстояния имеют решающее значение.

Аннотация эллипса

• Рисует эллиптические аннотации на странице документа.
• Позволяет пользователям выделять круглые или эллиптические области.
• Настраиваемый радиус, цвет и непрозрачность для четкой видимости.
• Поддержка нескольких ответов на добавленные комментарии в отмеченной области.

Аннотация к изображению

• Добавляет изображение в определенную область документа.
• Вставляет изображения на страницу документа для наглядности.
• Поддерживает позиционирование и изменение размера изображений.
• Полезно для добавления логотипов, штампов или визуальных знаков.

Аннотация к ссылке

• Добавляет гиперссылку в документ.
• Связывает определенный текст или области документа с внешними URL-адресами.
• Обеспечивает поддержку веб-навигации или ссылки на дополнительные ресурсы.
• Может быть оформлен разными цветами, чтобы отличаться от текста.

Множественная аннотация

• Позволяет добавлять несколько типов аннотаций одновременно.
• Поддерживает одновременное добавление комбинации аннотаций (например, текста, изображений, фигур).
• Полезно для просмотра документов, в которых на одной странице необходимы разные типы аннотаций.
• Несколько аннотаций можно группировать или обрабатывать отдельно.

Аннотация точки

• Прикрепляет комментарии к определенному месту документа.
• Комментарии связаны с определенной точкой или местом в документе.
• Идеально подходит для совместной проверки документов, когда необходима точная обратная связь.
• Поддерживает настройку цвета и размера для лучшей видимости.

Полилинейная аннотация

• Рисует соединенные линии для формирования полилинии в документе.
• Используется для рисования сложных фигур или обозначения определенных путей в документе.
• Поддерживает несколько точек, соединенных прямыми линиями.
• Позволяет настраивать толщину, цвет и непрозрачность линии.

Аннотация к редактированию ресурса

• Заполняет черный прямоугольник в фиксированном положении, чтобы скрыть конфиденциальную информацию.
• Эффективно удаляет конфиденциальную информацию из документов.
• Черный ящик можно изменить по размеру и расположить над любыми конфиденциальными данными.
• Обычно используется для юридических документов, финансовых отчетов или личных идентификационных номеров (ПИН-кодов).

Волнистая аннотация

• Добавляет волнистую линию для выделения текста.
• Выделяет текст волнистой линией для привлечения внимания.
• Идеально подходит для обозначения орфографических или грамматических ошибок.
• Цвет и стиль линий можно настроить, чтобы отличить их от других аннотаций.

Поддерживаемые форматы аннотаций

Приступаем к работе GroupDocs.Annotation Cloud Python SDK

Требования

Python 2.7 или 3.4+

Установка

Установите groupdocs-annotation-cloud с помощью PIP из PyPI следующим образом:

pip install groupdocs-annotation-cloud

Или клонируйте репозиторий и установите его через Setuptools:

python setup.py install

Пожалуйста, следуйте процедуре установки, а затем выполните следующее:

# 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

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

Пример кода Python 1: добавление текстовой аннотации

В этом примере кода показано, как добавить текстовую аннотацию к документу с помощью GroupDocs.Annotation Cloud SDK для Python. Текстовую аннотацию можно настраивать по положению, шрифту и цвету.

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

Пример кода Python 2: добавление аннотации области

В этом примере кода показано, как добавить аннотацию области (выделение раздела документа).

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

Пример кода Python 3: удаление аннотации

В этом примере кода показано, как удалить аннотацию из документа.

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