Установка

Пакет доступен на PyPI и может быть установлен через pip следующей командой:

pip install groupdocs-assembly-cloud

Требования

• Python 3.4+
• менеджер пакетов pip
• Учётные данные GroupDocs Cloud — Client ID и Client Secret из панели управления

Зависимости

SDK автоматически устанавливает следующие пакеты:

Облачный REST API автоматизации документов для Python

Облачный SDK GroupDocs.Assembly для Python позволяет разработчикам без труда автоматизировать создание сложных документов — отчётов, счетов и презентаций. Используйте шаблоны, объединяйте данные из источников JSON или XML, применяйте расширенное форматирование и генерируйте штрихкоды и диаграммы — всё в масштабируемой и безопасной облачной среде. Этот API упрощает рабочие процессы с документами, повышает продуктивность и обеспечивает кроссплатформенную совместимость для лёгкой интеграции в ваши Python веб-приложения, скрипты и автоматизированные рабочие процессы.

Основные возможности

Генерация документов на основе шаблонов — создавайте сложные документы Word, Excel, PowerPoint и PDF из шаблонов.
Динамическое объединение данных — заполняйте шаблоны данными JSON или XML для настраиваемых отчётов.
Расширенное форматирование и стилизация — применяйте продвинутое форматирование к тексту, таблицам и диаграммам для отполированных документов.
Условное управление содержимым — используйте условную логику для генерации динамического содержимого на основе данных.
Автоматизация списков и таблиц — создавайте динамические списки, таблицы и диаграммы, которые автоматически обновляются на основе данных.

Расширенные возможности

Генерация штрихкодов — встраивайте штрихкоды непосредственно в документы.
Вставка гиперссылок — добавляйте кликабельные ссылки на внешние ресурсы или внутри документа.
Создание закладок — создавайте закладки для удобной навигации.
Управление флажками — динамически устанавливайте значения флажков на основе данных.
Функциональность слияния почты — генерируйте персонализированные письма и вложения в масштабе.
Вычисления по формулам — выполняйте вычисления в электронных таблицах для динамических результатов.

Работа с данными

Фильтрация данных — применяйте фильтры для выбора определённых подмножеств данных для отчётов.
Сортировка данных — упорядочивайте данные в нужном порядке (по возрастанию/убыванию) по заданным критериям.
Группировка данных — организуйте данные в группы для удобного анализа и представления.
Форматирование данных — управляйте внешним видом данных в отчётах: числа, даты, текстовое форматирование.
Использование переменных — сохраняйте и повторно используйте значения в шаблоне для эффективной обработки.
Использование методов расширения — используйте встроенные функции для сложных манипуляций в шаблонах.

Работа со списками, таблицами и диаграммами

Динамическая генерация списков — создавайте встроенные, маркированные и нумерованные списки с динамическим содержимым.
Динамическая генерация таблиц — создавайте таблицы с динамическим содержимым, вычислениями и форматированием.
Генерация диаграмм — создавайте линейные, столбчатые, гистограммы, круговые, точечные и пузырьковые диаграммы с динамическими данными.
Настройка диаграмм — настраивайте заголовки диаграмм, ряды, заголовки осей и легенды через выражения.
Условные ряды диаграмм — условно включайте или исключайте ряды диаграмм в зависимости от условий.

Работа с гиперссылками, закладками и штрихкодами

Вставка гиперссылок — вставляйте гиперссылки в документы Word, электронную почту, электронные таблицы и презентации.
Динамическая вставка закладок — добавляйте закладки в документы/письма и задавайте имена для навигации.
Управление состоянием флажков — устанавливайте флажки отмеченными/снятыми в документах Word с помощью тега check.
Генерация изображений штрихкодов — генерируйте и вставляйте QR, DataMatrix, UPC, EAN, ISBN, PDF417 и многие другие типы штрихкодов.

Возможности для разработчиков

Архитектура REST API — используйте REST для простой интеграции и масштабируемости.
Подробная документация — получайте доступ к детальным справочникам API, примерам кода и руководствам.
Активная поддержка сообщества — получайте помощь на активном форуме и от выделенной службы поддержки.
Гибкость облачной платформы — пользуйтесь масштабируемостью и надёжностью облачной обработки.
Аутентификация JWT — защищайте данные и запросы API с помощью аутентификации JWT.

Лицензирование и аутентификация

Режим оценки — попробуйте API с бесплатной пробной учётной записью.
Безопасная аутентификация — используйте Client ID и Client Secret для безопасного доступа к API.
Лицензия MIT — Python SDK распространяется под лицензией MIT.

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

GroupDocs.Assembly Cloud поддерживает генерацию и преобразование на основе шаблонов для широкого спектра типов документов:

• Текстовые процессоры: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, HTML, MD, TXT, MHTML, MHT
• Электронные таблицы: XLS, XLSX, XLSM, XLTX, XLTM, XLSB, ODS
• Презентации: PPT, PPTX, PPTM, PPS, PPSX, PPSM, POT, POTX, POTM, ODP, OTP
• Электронная почта: MSG, EML, EMLX
• Веб и прочее: PDF, EPUB, XPS, OXPS, TIFF, SVG, XAML

Поддерживаемые выходные форматы зависят от типа исходного шаблона. Полную матрицу форматов см. в документации.

Быстрый старт

Получите учётные данные API

Чтобы использовать GroupDocs.Assembly Cloud, зарегистрируйтесь на панели управления GroupDocs.Cloud и получите Client ID и Client Secret.

Инициализация API

Используйте следующий код для начала работы с облачным SDK GroupDocs.Assembly для Python:

import groupdocsassemblycloud

# Get your ClientId and ClientSecret at https://dashboard.groupdocs.cloud
client_id = "YourClientId"
client_secret = "YourClientSecret"

# Create instance of the Assembly API
assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

Сборка документа из шаблона и данных JSON

После инициализации используйте этот базовый пример для генерации документа из шаблона и источника данных JSON:

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

# Upload the template file to cloud storage
with open("template.docx", "rb") as template_file:
    upload_request = requests.UploadFileRequest(template_file, path="template.docx")
    assembly_api.upload_file(upload_request)

# Read JSON data source
with open("data.json") as f:
    data = f.read()

template_file_info = groupdocsassemblycloud.TemplateFileInfo("template.docx")
options = groupdocsassemblycloud.AssembleOptions(template_file_info, save_format="docx", report_data=data)
request = requests.AssembleDocumentRequest(options)
result = assembly_api.assemble_document(request)

print("Generated document size = " + str(len(result)))

С этим кратким руководством вы готовы начать автоматизировать генерацию документов с помощью GroupDocs.Assembly Cloud в ваших Python-приложениях. Подробнее см. в документации.

Сборка документа в PDF

Сгенерируйте PDF-отчёт из шаблона OpenDocument и данных JSON.

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

filename = "TableFeatures.odt"
remote_name = "GroupDocs.Assembly/TableFeatures.odt"

with open("TableData.json") as f:
    data = f.read()

with open(filename, "rb") as template_file:
    upload_request = requests.UploadFileRequest(template_file, remote_name)
    assembly_api.upload_file(upload_request)

template_file_info = groupdocsassemblycloud.TemplateFileInfo(remote_name)
assemble_data = groupdocsassemblycloud.AssembleOptions(template_file_info, "pdf", data)
request = requests.AssembleDocumentRequest(assemble_data)
result = assembly_api.assemble_document(request)

print("Generated document size = " + str(len(result)))

Получение поддерживаемых форматов файлов

Получите полный список поддерживаемых форматов файлов, доступных через Assembly API.

import groupdocsassemblycloud
from groupdocsassemblycloud.models import requests

client_id = "YourClientId"
client_secret = "YourClientSecret"

assembly_api = groupdocsassemblycloud.AssemblyApi(client_id, client_secret)
assembly_api.api_client.configuration.host = "https://api.groupdocs.cloud"

result = assembly_api.get_supported_file_formats(requests.GetSupportedFileFormatsRequest())

for fmt in result.formats:
    print(fmt.file_format)

Примеры проектов на GitHub

Репозиторий облачного Python SDK GroupDocs.Assembly содержит готовые к запуску модульные тесты и примеры:

Как запустить примеры

1. Клонируйте или скачайте репозиторий SDK
2. Отредактируйте Settings/servercreds.json и укажите AppSid и AppKey
3. Установите зависимости: pip install groupdocs-assembly-cloud -U
4. Запустите тесты из корня репозитория: python -m unittest discover -s test

Подробнее см. в разделе Начало работы.

Теги

Document Automation | Python Cloud API | GroupDocs.Assembly Cloud | REST API | Document Generation | Template-Driven | Dynamic Data Merging | Rich Formatting | Conditional Content Control | List Automation | Table Automation | Barcode Generation | Hyperlink Insertion | Bookmark Creation | Checkbox Manipulation | Mail Merge | Formula Calculations | Chart Generation | Data Filtering | Data Sorting | Data Grouping | JWT Authentication | Microsoft Word | Microsoft Excel | Microsoft PowerPoint | Report Generation | Cloud-Based Flexibility | Secure API Access | Cross-platform API