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.1 supported.
Supported database backends: MariaDB/MySQL, PostgreSQL, SQLite.
Installation
First, install with pip:
python -m pip install django-harlequinSecond, install Harlequin with appropriate Harlequin adapter packages for the database backends you use. For example, to install Harlequin with the PostgreSQL adapter:
python -m pip install 'harlequin[postgres]'Harlequin does not need to be installed in the same virtual environment as Django, as django-harlequin does not import it. You only need the harlequin command on your path, so you can install Harlequin globally, or in an isolated virtual environment with a tool like pipx.
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 harlequinPass --database to select a different database connection from settings.DATABASES:
$ ./manage.py harlequin --database replicaExtra 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 -- --helpConfiguration
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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_harlequin-1.2.0.tar.gz.
File metadata
- Download URL: django_harlequin-1.2.0.tar.gz
- Upload date:
- Size: 7.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a36e6005f693cde9ff6b34d2100a438b794aa93debe6ae35a68a5ff9e0fa94be
|
|
| MD5 |
491f00ad26a81fe8074f863f77ddaf26
|
|
| BLAKE2b-256 |
53c1d6f47a0710e276507781572820e838c350041910e1b7d7547f9cb3cfa3f0
|
File details
Details for the file django_harlequin-1.2.0-py3-none-any.whl.
File metadata
- Download URL: django_harlequin-1.2.0-py3-none-any.whl
- Upload date:
- Size: 5.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/5.1.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
082c0f399927c2e20559e6a0f94a70e830eeb50719da6940547175fb42804459
|
|
| MD5 |
7e5cf59dc007f4d62be5f8db2fe96574
|
|
| BLAKE2b-256 |
989d32b30553c7bf250a774e781704dda26545f329e46196f203a667ae5aee52
|
