Report Generator for Python

Python library to build highly customized reports using REST API

Seamlessly integrate generation of Word, PDF and Web documents based on templates and data sources into your Python software.

Automate document generation in Python, create print-ready reports of any complexity with Python SDK. This Cloud-based solution is built around templates, data sources and a powerful LINQ-syntax, giving Python developers the flexibility to fit precise technical and business requirements.

Using this Python library, you can programmatically build highly customized reports on any operating system. Richly formatted documents like contracts, orders, invoices, shipment reports, sales proposals, inventories can be assembled on the fly as a part of your Python software.

Streamline document generation using Python

The importance of Document Automation and Report Generation has grown immensely over the past decades. Almost every company has a need to generate documents and deliver them to partners or customers on time. Moreover, it is usually a decisive factor in financial success. Implementing such technologies can result in significant financial savings by reducing manual data entry, human error, proofreading and paperwork. For these reasons, document automation and reporting tools are an integral part of many modern software solutions that aim to provide advanced analytical features to users.

Generally speaking, report generation is a process that combines text, data and graphics into a single entity and exports the result in a convenient visual form to the required document format, such as DOCX, PDF, ODT, HTML, PPTX, XLSX, etc.

What is GroupDocs Assembly for Python

GroupDocs Assembly for Python is a Cloud-based solution for generating documents using templates and data sources. The document template acts as a base-frame, which, in addition to the standard content (text, tables, charts, etc.), includes special placeholder fields for inserting values from the data source. Not only individual values can be inserted, but also entire arrays of data in the form of tables and graphs.

The template also contains programming constructs - document generation rules - that control data selection and condition processing. Binding data to a document template uses LINQ-expression syntax, which allows developers to process data in a generic way, regardless of the type of data source used. In this way, our Python Cloud SDK gives you flexibility in content generation and a powerful set of methods for data processing.

This product also supports Mail Merge functionality in case you want to create and send batches of personalized letters to customers. You just need to insert Mail Merge fields to the document template and pass it to the Cloud API together with a data source.

Regardless of the scale and type of document automation you are going to implement, there are three steps to build a report in Python:

  • Create a Word document template with placeholder fields and document generation rules that will regulate structure and content variations
  • Create a data source in XML or JSON format
  • Write a few lines of Python code to pass everything to the Document Building API and get the assembled result back

Designing a document template and using document generation rules

Designing templates is a difficult task. In addition to a clear understanding of the requirements for the final document, analytical and programming skills are required. A good template design should reflect the customer's view on a particular issue. The most effective approach is to combine tabular data and graphics in the right balance, determined by business requirements.

As mentioned above, the template structure usually contains some fixed blocks of content (text, images, logos, etc.) mixed with special programming constructs that control document assembly logic. These document generation rules are defined with a special expression syntax, which enables developers to do the following:

  • embed external document content, images, charts, lists, tables, hyperlinks, bookmarks, etc.
  • work with data using formulas and sequential data operations
  • specify the presentation format for numeric, text, graphic, graphic, and date and time elements
  • insert blocks of content depending on conditional expressions
  • define special variables for 'expensive' calculations that are calculated only once
  • calculate formulas when assembling spreadsheet documents
  • assign email message body attributes and dynamically create attachments
  • create and insert barcodes
  • set background color for HTML documents

You can learn more about template syntax in our Developer Guide.

Requirements

GroupDocs Assembly for Python does not require any external software or third-party tools to be installed. This is a Cloud-based solution, where all programming interactions are performed over the network using the REST API.

Supported Document Formats

  • Word: DOCX, DOC, DOT, DOTX, DOTM, DOCM, RTF
  • Excel: XLSX, XLS, XLSM, XLSB, XLT, XLTM, XLTX
  • PowerPoint: PPTX, PPT, PPTM, PPS, PPSX, PPSM, POT, POTX, POTM
  • Outlook: MSG, EML, EMLXL
  • OpenOffice: ODT, OTT, ODS, ODP, OTP
  • Adobe Acrobat: PDF
  • Printing: PCL, PS, XPS, OXPS
  • Vector Graphics: SVG, EMF
  • Bitmap Graphics: PNG, JPEG, GIF, TIFF, BMP
  • Other File Formats: HTML, MHTML, MHT, MD, XAML, EPUB, TXT

For more information on supported I/O formats, please visit our Documentation.

Security

All GroupDocs products are fully compliant with industry security standards: data transfer is carried out using the SSL protocol, which eliminates the possibility of information being intercepted by third parties. To connect to GroupDocs Cloud Services, you need to use personal access keys. Please refer to the Quick Start guide.

Generate a document in Python

The following code example shows how to generate reports using Python.

Generate a document in Python
Input files
Upload a document template
Output format
Select the target format from the list
import groupdocsassemblycloud

assembly_api = 
	groupdocsassemblycloud.AssemblyApi('####-####-####-####-####', '##################')
file_name= 'Input1.docx'
data_file= 'Input2.docx'

request_file_content = open(file_name, 'rb')
upload_document_request = 
	requests.UploadFileRequest(file_content=request_file_content, path=file_name)
assembly_api.upload_file(upload_document_request)

data = open(data_file, 'rb')
template_file_info = groupdocsassemblycloud.models.TemplateFileInfo(file_name)

assemble_options = groupdocsassemblycloud.models.AssembleOptions(template_file_info, "docx", data)
request = groupdocsassemblycloud.models.requests.AssembleDocumentRequest(assemble_options)
assembly_api.assemble_document(request)
  
Copy Python code to the clipboard

How to generate a document using Python

  1. Install 'GroupDocs.Assembly Cloud SDK for Python'.
  2. Add a library reference (import the library) to your Python project.
  3. Create a template document, add programming constructs that control the insertion of data from the data source.
  4. Create a data source.
  5. Upload the document template to the GroupDocs Cloud Storage (you need to log in to your personal account).
  6. Generate a document by passing your template and data to the Cloud API.

How to install Cloud Report Generator for Python

Install GroupDocs.Assembly Cloud SDK for Python using PyPi repository. Run pip install groupdocs-assembly-cloud to install the SDK, then import the package via import groupdocs-assembly-cloud. As an alternative, you can manually clone GroupDocs.Assembly Cloud SDK for Python source code from GitHub and use it in your project. Please follow these Instructions to quickly get the necessary security credentials and access our REST API.

System Requirements

Refer to the Repository Documentation to see the details.

5%

Subscribe to Aspose Product Updates

Get monthly newsletters and offers directly delivered to your mailbox.

© Aspose Pty Ltd 2001-2022. All Rights Reserved.