https://github.com/alissonperez/django-onmydesk
A Django app to build reports in a simple way.
https://github.com/alissonperez/django-onmydesk
Last synced: 3 months ago
JSON representation
A Django app to build reports in a simple way.
- Host: GitHub
- URL: https://github.com/alissonperez/django-onmydesk
- Owner: alissonperez
- License: mit
- Created: 2016-06-08T17:31:24.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2016-06-10T18:02:35.000Z (almost 9 years ago)
- Last Synced: 2025-01-12T17:11:18.424Z (5 months ago)
- Language: Python
- Homepage:
- Size: 128 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://travis-ci.org/knowledge4life/django-onmydesk.svg?branch=develop
:target: https://travis-ci.org/knowledge4life/django-onmydesk
.. image:: https://readthedocs.org/projects/django-onmydesk/badge/?version=latest
:target: http://django-onmydesk.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://badge.fury.io/py/django-onmydesk.svg
:target: https://badge.fury.io/py/django-onmydesk
.. image:: https://img.shields.io/github/issues/knowledge4life/django-onmydesk.svg
:target: https://github.com/knowledge4life/django-onmydesk/issues
.. image:: https://img.shields.io/badge/license-MIT-blue.svg
:target: https://raw.githubusercontent.com/knowledge4life/django-onmydesk/develop/LICENS
.. image:: https://coveralls.io/repos/github/knowledge4life/django-onmydesk/badge.svg?branch=develop
:target: https://coveralls.io/github/knowledge4life/django-onmydesk?branch=develop
Django - OnMyDesk
===================
A Django app to build reports in a simple way.
Installation
------------
With pip::
pip install django-onmydesk
Add 'onmydesk' to your INSTALLED_APPS::
INSTALLED_APPS = [
# ...
'onmydesk',
]
Run `./manage.py migrate` to create **OnMyDesk** models.
Quickstart
-----------
To create reports we need to follow just two steps:
1. Create a report class in our django app.
2. Add this report class to a config in you project settings to enable **OnMyDesk** to see your reports.
So, let's do it!
Create a module called *reports.py* in you django app with the following content:
myapp/reports.py::
from onmydesk.core import reports
class UsersReport(reports.SQLReport):
name = 'Users report'
query = 'SELECT * FROM auth_user'
On your project settings, add the following config::
ONMYDESK_REPORT_LIST = [
'myapp.reports.UsersReport',
]
Each new report must be added to this list. Otherwise, it won't be shown on admin screen.
Now, access your **OnMyDesk** admin screen and you'll see your **Users report** available on report creation screen.
After you create a report, it'll be status settled up as 'Pending', to process it you must run `process` command. E.g::
$ ./manage.py process
Found 1 reports to process
Processing report #29 - 1 of 1
Report #29 processed
Collaboration
-------------
There are many ways of improving and adding more features, so feel free to collaborate with ideas, issues and/or pull requests.
Let us know!
-------------
We'd be really happy if you sent us links to your projects where you use our component. Just create an issue and let us know if you have any questions or suggestion regarding the library.