Metadata-Version: 1.1
Name: django-querybuilder
Version: 0.0.3
Summary: AJAX tables and maps made simple
Home-page: http://github.com/qedsoftware/django-querybuilder
Author: Quantitative Engineering Design Inc.
Author-email: michal@qed.ai
License: UNKNOWN
Description: Django Querybuilder 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/).
        
        Running examples
        ================
        
        You can see example Django project using Django Querybuilder 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.
        
            -e git+git://github.com/qedsoftware/django-querybuilder#egg=django-querybuilder
            -e git+git://github.com/annaproch/django-datatable-view#egg=django-datatable-view   # for querybuilder
        
        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_querybuilder/static/django_querybuilder/libs
            /django_querybuilder/static/django_querybuilder/css
        
        **Do not modify them manually.**
        
        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_querybuilder
        
        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_querybuilder/*py
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Framework :: Django
