To contribute to this library, first checkout the code. Then create a new virtual environment:

cd django-sql-dashboard
python -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and tests:

pip install -e '.[test]'

Running the tests

To run the tests:


Generating new migrations

To generate migrations for model changes:

cd test_project
./ makemigrations

Code style

This library uses Black for code formatting. The correct version of Black will be installed by pip install -e '.[test]' - you can run black . in the root directory to apply those formatting rules.


Documentation for this project uses MyST - it is written in Markdown and rendered using Sphinx.

To build the documentation locally, run the following:

cd docs
pip install -r requirements.txt
make livehtml

This will start a live preview server, using sphinx-autobuild.