{"id":13502172,"url":"https://github.com/mining/django-report","last_synced_at":"2025-03-29T10:32:48.607Z","repository":{"id":24266406,"uuid":"27660503","full_name":"mining/django-report","owner":"mining","description":"Django report, Open Mining Server Interface","archived":false,"fork":false,"pushed_at":"2014-12-07T16:02:38.000Z","size":152,"stargazers_count":15,"open_issues_count":1,"forks_count":2,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-09T00:49:00.048Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/mining/mining","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mining.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-12-07T05:31:38.000Z","updated_at":"2017-01-11T12:02:22.000Z","dependencies_parsed_at":"2022-08-06T01:15:38.203Z","dependency_job_id":null,"html_url":"https://github.com/mining/django-report","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining%2Fdjango-report","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining%2Fdjango-report/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining%2Fdjango-report/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mining%2Fdjango-report/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mining","download_url":"https://codeload.github.com/mining/django-report/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246174207,"owners_count":20735406,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T22:02:04.718Z","updated_at":"2025-03-29T10:32:48.223Z","avatar_url":"https://github.com/mining.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"=============\ndjango-report\n=============\n\nDjango report, Open Mining Server Interface\n\nDjango Report provides modular report for Django. It features a unified, familiar API that allows you to plug in different search backends (such as `Open Mining \u003chttps://github.com/avelino/mining\u003e`_) without having to modify your code.\n\n\nInstallation\n============\n\nUse your favorite Python package manager to install the app from PyPI, e.g.\n\nExample::\n\n    pip install django-report\n\n\nConfiguration\n=============\n\nAdd django-report To ``INSTALLED_APPS``\n---------------------------------------\n\nAs with most Django applications, you should add **report** to the\n``INSTALLED_APPS`` within your settings file (usually ``settings.py``).\n\nExample::\n\n    INSTALLED_APPS = [\n        'django.contrib.admin',\n        'django.contrib.auth',\n        'django.contrib.contenttypes',\n        'django.contrib.sessions',\n        'django.contrib.sites',\n\n        # Added.\n        'report',\n\n        # Then your usual apps...\n        'myapp.note',\n    ]\n\n\nModify Your ``settings.py``\n---------------------------\n\nWithin your ``settings.py``, you'll need to add a setting to indicate where your\nsite configuration file will live and which backend to use, as well as other\nsettings for that backend.\n\nOpen Mining\n~~~~~~~~~~~\n\nExample::\n\n    REPORT_URL = 'http://127.0.0.1:8888'\n\n\nHandling Data\n=============\n\nCreating ``ReportClass``\n------------------------\n\n``ReportClass`` objects are the way django-report determines what data should be\nplaced in the handles the flow of data in.\n\nThis code generally goes in a ``reports.py`` file within the app\nit applies to, though that is not required.::\n\n    # -*- coding: utf-8 -*-\n    from report.backends.mining import Mining\n    from myapp.models import Note\n    \n    \n    class NoteMining(Mining):\n        model = Note\n    \n        def get_queryset(self):\n            \"\"\"Used when the entire index for model is updated.\"\"\"\n            return self.model.objects.all()\n\n\nBuild\n-----\n\nThe final step, now that you have everything setup, is to put your data in\nfrom your database into the report system. django-report ships with a management\ncommand to make this process easy.\n\nSimply run ``./manage.py update_report``. You'll get some totals of how many\nmodels were processed and placed in the report systeam.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining%2Fdjango-report","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmining%2Fdjango-report","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmining%2Fdjango-report/lists"}