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. 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.0.0.tar.gz (6.8 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.0.0-py3-none-any.whl (5.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_harlequin-1.0.0.tar.gz
  • Upload date:
  • Size: 6.8 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.0.0.tar.gz
Algorithm Hash digest
SHA256 77bd1e283344f711b0b8759d01fbb4016920f1a077c5fa993bad86b1f1b9888a
MD5 c23482a0682b9e24173270519413279c
BLAKE2b-256 b084d6a124d82bc2da541eb9bcf9b5514519cabade0f775ad7a8810a39a09f3f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_harlequin-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cb6ece9e5edfe1d36634974352036bccd7048e01bf9f23e6d11058cdd63b3eef
MD5 36abe1a01f4b4280a1e231a7e1964398
BLAKE2b-256 b1518f910b45d91895cfe264f57fa5a95b4d89380f0482c427c2961e64b6bc30

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