Metadata-Version: 2.4
Name: reportbro-lib
Version: 3.12.0
Summary: Generate PDF and Excel reports from visually designed templates
License: AGPL-3.0
License-File: LICENSE
Keywords: pdf,excel,report,generate,create,web,template,layout
Author: jobsta
Author-email: alex@reportbro.com
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: Babel (>=2.14.0,<3.0.0)
Requires-Dist: Pillow (>=10.2.0,<11.0.0)
Requires-Dist: XlsxWriter (>=3.0.3,<4.0.0)
Requires-Dist: python-barcode (>=0.15.1,<0.16.0)
Requires-Dist: qrcode (>=7.4.2,<8.0.0)
Requires-Dist: reportbro-fpdf2 (>=2.8.2,<3.0.0)
Requires-Dist: simpleeval (>=1.0.3,<2.0.0)
Project-URL: Documentation, https://www.reportbro.com/doc/installation
Project-URL: Homepage, https://www.reportbro.com
Project-URL: Repository, https://github.com/jobsta/reportbro-lib
Description-Content-Type: text/x-rst

ReportBro Lib
=================

ReportBro is a library to generate PDF and XLSX reports. Report templates can be created
with `ReportBro Designer <https://github.com/jobsta/reportbro-designer>`_,
a Javascript Plugin which can be integrated in your web application.

See the ReportBro project website on https://www.reportbro.com for full documentation and demos.

Features
--------

* Python >= 3.10 support
* Generate pdf and xlsx reports
* Supports (repeating) header and footer
* Allows predefined and own page formats
* Use text, line, images, barcodes and tables, page breaks
* Text and element styling
* Evaluate expressions, define conditional styles, format parameters

Installation
------------

.. code:: shell

    pip install reportbro-lib

Go to https://www.reportbro.com/framework/api#lib-arguments for more information on configuration and usage.

Python Coding Style
-------------------

The `PEP 8 (Python Enhancement Proposal) <https://www.python.org/dev/peps/pep-0008/>`_
standard is used which is the de-facto code style guide for Python. An easy-to-read version
of PEP 8 can be found at https://pep8.org

For pull requests the same coding styles should be used.

ReportBro Cloud
---------------

With ReportBro Cloud you can manage all your reports in your account and use only a simple web request in your application to get the report file. `Try ReportBro as cloud service <https://www.reportbro.com/auth_user/register>`_.

License
-------

ReportBro is dual licensed. You can coose depending on your use case.
Read more about ReportBro's license options at https://www.reportbro.com/pricing/index#framework-license.

- Commercial license

If you want to use ReportBro to develop commercial applications and projects, the Commercial license is the appropriate license.
See https://www.reportbro.com/framework/license_agreement for the full license text.
With this license, your source code is kept proprietary. Purchase a ReportBro Commercial license at https://www.reportbro.com/pricing/index#framework-license.

This license includes ReportBro PLUS with additional features.

- Open-source license

If you are creating an open-source application under a license compatible with the `GNU AGPL license v3 <https://www.gnu.org/licenses/agpl-3.0.html>`_, you may use ReportBro under the terms of the AGPLv3.

Contributing
------------

We are always happy about new contributions. See CONTRIBUTING.md for details.

