Skip to main content

Python client to AppReport API

Project description

## app_report-python

app_report-python is a Python client to the [AppReport API](http://reports.simpleservic.es/), it allows you to generate pdf reports based on Jasper library in a simple way.

### Installation

* For **Web2py framework** users, please read [Using the AppReport client on Web2py Apps](https://github.com/simpleservices/app_report-python/wiki/Using-the-AppReport-client-on-Web2py-Apps).

* For **Windows** users, please read [How to install pip on Windows](https://github.com/simpleservices/app_report-python/wiki/How-to-install-pip-on-Windows).

* Or, if you are using **Python on Linux**, follow this steps:

```console
# create a file requirements.txt and add this line:
app_report

# after save it, run the install command:
$ pip install -r requirements.txt
```

### Try it now

* This example assumes that you already drawn your report using some tool like [i-report designer](http://community.jaspersoft.com/project/ireport-designer) and uploaded the .jrxml file to the [AppReport site](http://reports.simpleservic.es/), as a "report template",

to make the things easy, we did it for you :) yay donuts for us.

```python
import app_report
from app_report.helpers.reports import jasper_report
from urllib2 import urlopen

app_report.AppReport.configure({
'app_name': 'shop',
'access_key': 'udPONmbmD01MnxzMVgiL',
'secret_key': 'ExINJLBR1I6Au6Hu0gQQoQmTMXAZuHk1Tkx3N19V'
})

xml_data = urlopen('http://reports.simpleservic.es/sample_resources/products.xml').read()
report = jasper_report(template_name='products', data=xml_data, xpath_expression='/products/product')

open('report.pdf', 'w').write(report)

```

<b>Just it!</b> AppReport is a really simple, no more complex configurations or boring installations are required, just connect to AppReport API and start generating reports!

## Contribute
You can contribute sending pull requests, don't forget to write tests for your code and check the pep8 conventions :)

```console
$ pip install -r development-requirements.txt
$ pip install -r test-requirements.txt

$ fab test

$ fab check_pep8
# p.s. the "Maximum Line Length" (of 79 chars) convention are being ignored.
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

app_report-0.0.3.tar.gz (9.4 kB view details)

Uploaded Source

File details

Details for the file app_report-0.0.3.tar.gz.

File metadata

  • Download URL: app_report-0.0.3.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for app_report-0.0.3.tar.gz
Algorithm Hash digest
SHA256 f3d2bf6e3c78ddf897243e0a50da15cbdbcd94779a814be1810a7f591e2971ab
MD5 31bece415a098c7c5af7b99fdd8316fb
BLAKE2b-256 a547f4f4cee5191f729481af98ec205e1fdf5115e80bfbf9f374d2e4328b50f7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page