Skip to main content
https://img.shields.io/github/actions/workflow/status/adamchainz/django-harlequin/main.yml.svg?branch=main&style=for-the-badge https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge https://img.shields.io/pypi/v/django-harlequin.svg?style=for-the-badge https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge pre-commit

Launch Harlequin, the SQL IDE for your Terminal, with your Django database configuration.


Work smarter and faster with my book Boost Your Django DX which covers many tools to improve your development experience.


Requirements

Python 3.8 to 3.12 supported.

Django 3.2 to 5.0 supported.

Supported database backends: MariaDB/MySQL, PostgreSQL, SQLite.

Installation

First, install with pip:

python -m pip install django-harlequin

Second, install the appropriate Harlequin adapter package for your database backend, if necessary (SQLite is built-in). For example, for the PostgreSQL adapter:

python -m pip install harlequin-postgres

Third, add the app to your INSTALLED_APPS setting:

INSTALLED_APPS = [
    ...,
    "django_harlequin",
    ...,
]

Usage

harlequin command

Run the harlequin management command to launch Harlequin, connected to your default database:

$ ./manage.py harlequin

Pass --database to select a different database connection from settings.DATABASES:

$ ./manage.py harlequin --database replica

Extra options, optionally after a -- delimiter, will be passed through to Harlequin. For example, to read its help page, as opposed to that of the management command:

$ ./manage.py harlequin -- --help

Configuration

Harlequin automatically loads configuration from pyproject.toml or its own files within the current working directory, which would mean next to your manage.py file. See Harlequin’s configuration documentation for details on the available options.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_harlequin-1.1.1.tar.gz (6.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_harlequin-1.1.1-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

Details for the file django_harlequin-1.1.1.tar.gz.

File metadata

  • Download URL: django_harlequin-1.1.1.tar.gz
  • Upload date:
  • Size: 6.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for django_harlequin-1.1.1.tar.gz
Algorithm Hash digest
SHA256 305a243a4dd4a32170aa376a628a559984fa20bad70468e4e24830197716a59f
MD5 e1e47d8c41320584c0742f60ae2bc7b8
BLAKE2b-256 0919de7c09240e3a8c48f86f058cc5c8821725f6a3adf10c9ce0c333d345dc38

See more details on using hashes here.

File details

Details for the file django_harlequin-1.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_harlequin-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 af520f27b7c9ac5959c3eabe0e74f7377f1846a11b2b7492c6f001488b016021
MD5 d65695d79090a49f5460a42139f11a03
BLAKE2b-256 2c15f2b945e92e488253fe06e8dbaf14b83e2669b9f07df99733050a0b75e81a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page