https://github.com/grantmcconnaughey/django-reports

A Django app to easily create and render reports.
https://github.com/grantmcconnaughey/django-reports

Last synced: 12 days ago
JSON representation

A Django app to easily create and render reports.

• Host: GitHub
• URL: https://github.com/grantmcconnaughey/django-reports
• Owner: grantmcconnaughey
• License: bsd-3-clause
• Created: 2016-01-13T16:38:37.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:00:25.000Z (almost 2 years ago)
• Last Synced: 2024-02-25T12:23:16.221Z (10 months ago)
• Language: Python
• Size: 25.4 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================

django-reports

=============================

.. image:: https://badge.fury.io/py/django-reports.png

    :target: https://badge.fury.io/py/django-reports

.. image:: https://travis-ci.org/grantmcconnaughey/django-reports.png?branch=master

    :target: https://travis-ci.org/grantmcconnaughey/django-reports

.. image:: https://coveralls.io/repos/grantmcconnaughey/django-reports/badge.svg?branch=master&service=github

  :target: https://coveralls.io/github/grantmcconnaughey/django-reports?branch=master

A Django app to easily create and render reports.

Documentation

-------------

The full documentation is at https://django-reports.readthedocs.org.

Quickstart

----------

Install django-reports::

    pip install django-reports

Then use it in a project::

    from djreports import Report

    class MyReport(Report):

        title = 'My Report'

        description = 'A list of important things'

        def get_data(self):

            return [

                ['Name', 'Age'],

                ['Grant', '24'],

                ['Erica', '24'],

            ]

    report = MyReport()

And render the report in your template::

    {% load djreport_tags %}

    {% report_table report %}

Features

--------

* Create report objects out of Python lists.

* Render them to an HTML table.

Running Tests

--------------

Does the code actually work?

::

    source /bin/activate

    (myenv) $ pip install -r requirements-test.txt

    (myenv) $ python runtests.py

Credits

---------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-pypackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage