https://github.com/qedsoftware/django-data-explorer
Auto-generate granular queries and geospatial visualizations of data tables.
https://github.com/qedsoftware/django-data-explorer
Last synced: about 1 year ago
JSON representation
Auto-generate granular queries and geospatial visualizations of data tables.
- Host: GitHub
- URL: https://github.com/qedsoftware/django-data-explorer
- Owner: qedsoftware
- License: bsd-3-clause
- Created: 2016-05-05T18:41:01.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-06-10T19:27:21.000Z (about 5 years ago)
- Last Synced: 2025-04-11T16:18:56.396Z (about 1 year ago)
- Language: CSS
- Homepage: http://djangoqb.qed.ai
- Size: 12.7 MB
- Stars: 11
- Watchers: 6
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Django Data Explorer facilitates visualizing data using AJAX tables and maps
with filters in Django applications.
You can see the examples at [http://djangoqb.qed.ai/](http://djangoqb.qed.ai/).
Previously this project was released under name `django-querybuilder`
Running examples
================
You can see example Django project using Django Data Explorer in directory
`example`. Go to the directory and execute:
pip install -r requirements.txt
And then:
./manage.py runserver
Using in your application
=========================
Add those lines to you project requirements or use them as PIP arguments.
django-data-explorer
-e git+git://github.com/qedsoftware/django-datatable-view#egg=django-datatable-view # for data-explorer
Afterwards, you can use our package the same way as in the example. You can
also consult docstrings.
For developers
==============
Frontend requirements
---------------------
To get frontend dependencies, you need to have `Node.js` installed.
After installing `Node.js`, install the frontend dependencies by running
the following from the root of your Django checkout:
npm install
npm run deps
Then build frontend files:
npm run build
For development run
npm run start
that way build will happen automatically each time you change any related files.
Django static files - important note
------------------------------------
Contents of the folders listed below are generated automatically.
/django_data_explorer/static/django_data_explorer/dist
/django_data_explorer/static/django_data_explorer/css
/django_data_explorer/static/django_data_explorer/libs
Modifying them manually does not make much sense, as they will be overridden.
They are included to enable the package to work immediately after installing it via pip.
Documentation
-------------
In Python, see docstrings for documentation. You can also browse them using
`help` method and using:
python -m pydoc django_data_explorer
Generate JavaScript docs into directory `js_docs`:
npm run js-docs
Running tests
=============
Django
------
./manage.py jenkins
Frontend
--------
npm test
All tests
--------
./jenkins.py
Test coverage
=============
JavaScript test coverage is available in the test output. To see Python coverage
report, execute in directory `example`:
coverage3 run ./manage.py test
coverage3 html ../django_data_explorer/*py