Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Authors | ||
======= | ||
|
||
* Antonio Corroppoli | ||
* Dario Pavone | ||
* Marco Pattaro | ||
* Matteo Atti | ||
* Michele Totaro |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
Copyright (c) Simplyopen s.r.l. and individual contributors. | ||
All rights reserved. | ||
|
||
Redistribution and use in source and binary forms, with or without modification, | ||
are permitted provided that the following conditions are met: | ||
|
||
1. Redistributions of source code must retain the above copyright notice, | ||
this list of conditions and the following disclaimer. | ||
|
||
2. Redistributions in binary form must reproduce the above copyright | ||
notice, this list of conditions and the following disclaimer in the | ||
documentation and/or other materials provided with the distribution. | ||
|
||
3. Neither the name of django-admin-reports nor the names of its | ||
contributors may be used to endorse or promote products derived | ||
from this software without specific prior written permission. | ||
|
||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND | ||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED | ||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE | ||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR | ||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | ||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | ||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON | ||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS | ||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
include LICENSE | ||
include README.rst | ||
include AUTHORS.rst | ||
include MANIFEST.in | ||
exclude *.pyc | ||
recursive-include admin_reports/templates *.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
==================== | ||
django-admin-reports | ||
==================== | ||
|
||
Overview | ||
######## | ||
|
||
"admin_reports" is a Django application to easily create data | ||
aggregation reports to display inside Django admin. | ||
|
||
The Django admin is very much centered on models and it provide a | ||
quick and simple way to create a GUI for the CRUD interface, but | ||
ofthen there's the need to display data in an aggregate form, here's | ||
where admin_reports comes handy. | ||
|
||
Usage | ||
##### | ||
|
||
Basically admin_reports provide you Django site with an abstract view | ||
``ReportView``. All you need to do is give an implementation to the | ||
abstract method ``aggregate()``. The important thing is that this | ||
method must return a list of dictionaries, a Queryset or a | ||
``pandas.Dataframe`` (https://github.com/pydata/pandas). | ||
|
||
A stupid example could be this: | ||
:: | ||
class MyReport(ReportView): | ||
def aggregate(self, **kwargs): | ||
return [ | ||
dict([(k, v) for v, k in enumerate('abcdefgh')]), | ||
dict([(k, v) for v, k in enumerate('abcdefgh')]), | ||
] |