Skip to main content

A simple Django app to build reports.

Project description Documentation Status

Django - OnMyDesk

A Django app to build reports in a simple way.


With pip:

pip install django-onmydesk

Add ‘onmydesk’ to your INSTALLED_APPS:

    # ...

Run ./ migrate to create OnMyDesk models.


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 in you django app with the following content:


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:


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:

$ ./ process
Found 1 reports to process
Processing report #29 - 1 of 1
Report #29 processed


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

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

django-onmydesk-0.1.0.tar.gz (22.8 kB view hashes)

Uploaded Source

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