Dependencies

An effort has been made to keep the number of dependencies to a minimum.

Python

Name	Version	License
sqlparse	0.4.0	BSD

• sqlparse is used for SQL formatting

Python - Optional Dependencies

Name	Version	License
celery	>=3.1,<4	BSD
django-celery	>=3.3.1	BSD
Factory Boy	>=3.1.0	MIT
xlsxwriter	>=1.3.6	BSD
boto	>=2.49	MIT

• Factory Boy is required for tests

• celery is required for the ‘email’ feature, and for snapshots

• boto is required for snapshots

• xlsxwriter is required for Excel export (csv still works fine without it)

JavaScript & CSS

Please see package.json for the full list of JavaScript dependencies.

Vite builds the JS and CSS bundles for SQL Explorer. The bundle for the SQL editor is fairly large at ~400kb, due primarily to CodeMirror. There is opportunity to reduce this by removing jQuery, which we hope to do in a future release.

The built front-end files are distributed in the PyPi release (and will be found by collectstatic). Instructions for building the front-end files are in install.rst.

Tests

Factory Boy is needed if you’d like to run the tests, which can you do easily:

python manage.py test

and with coverage:

coverage run --source='.' manage.py test

then:

coverage report

…97%! Huzzah!

Running Locally

Included is a test_project that you can use to kick the tires. Just create a new virtualenv, cd into test_project and run start.sh (or walk through the steps yourself) to get a test instance of the app up and running.

You can now navigate to 127.0.0.1:8000/ and begin exploring!