| Name | django-harlequin JSON |
| Version |
1.5.0
JSON |
| download |
| home_page | None |
| Summary | Launch Harlequin, the SQL IDE for your Terminal, with your Django database configuration. |
| upload_time | 2025-02-06 22:14:54 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | None |
| keywords |
django
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
================
django-harlequin
================
.. image:: https://img.shields.io/github/actions/workflow/status/adamchainz/django-harlequin/main.yml.svg?branch=main&style=for-the-badge
:target: https://github.com/adamchainz/django-harlequin/actions?workflow=CI
.. image:: https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge
:target: https://github.com/adamchainz/django-harlequin/actions?workflow=CI
.. image:: https://img.shields.io/pypi/v/django-harlequin.svg?style=for-the-badge
:target: https://pypi.org/project/django-harlequin/
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge
:target: https://github.com/psf/black
.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge
:target: https://github.com/pre-commit/pre-commit
:alt: pre-commit
Launch `Harlequin <https://harlequin.sh/>`__, the SQL IDE for your Terminal, with your Django database configuration.
----
**Work smarter and faster** with my book `Boost Your Django DX <https://adamchainz.gumroad.com/l/byddx>`__ which covers many tools to improve your development experience.
----
Requirements
============
Python 3.9 to 3.13 supported.
Django 4.2 to 5.2 supported.
Supported database backends: MariaDB/MySQL, PostgreSQL, SQLite.
Installation
============
**First,** install with pip:
.. code-block:: bash
python -m pip install django-harlequin
**Second,** install Harlequin with appropriate Harlequin `adapter packages <https://harlequin.sh/docs/adapters>`__ for the database backends you use.
For example, to install Harlequin with the `PostgreSQL adapter <https://harlequin.sh/docs/postgres/index>`__:
.. code-block:: bash
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 <https://pipx.pypa.io/latest/installation/>`__.
**Third,** add the app to your ``INSTALLED_APPS`` setting:
.. code-block:: python
INSTALLED_APPS = [
...,
"django_harlequin",
...,
]
Usage
=====
``harlequin`` command
---------------------
Run the ``harlequin`` management command to launch Harlequin, connected to your default database:
.. code-block:: console
$ ./manage.py harlequin
Pass ``--database`` to select a different database connection from ``settings.DATABASES``:
.. code-block:: console
$ ./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:
.. code-block:: console
$ ./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 <https://harlequin.sh/docs/config-file>`__ for details on the available options.
Raw data
{
"_id": null,
"home_page": null,
"name": "django-harlequin",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Django",
"author": null,
"author_email": "Adam Johnson <me@adamj.eu>",
"download_url": "https://files.pythonhosted.org/packages/a9/49/35a2dd00a6859083bb5bea6602b9aa7a78a11ae9fbbb5a7715793ca24805/django_harlequin-1.5.0.tar.gz",
"platform": null,
"description": "================\ndjango-harlequin\n================\n\n.. image:: https://img.shields.io/github/actions/workflow/status/adamchainz/django-harlequin/main.yml.svg?branch=main&style=for-the-badge\n :target: https://github.com/adamchainz/django-harlequin/actions?workflow=CI\n\n.. image:: https://img.shields.io/badge/Coverage-100%25-success?style=for-the-badge\n :target: https://github.com/adamchainz/django-harlequin/actions?workflow=CI\n\n.. image:: https://img.shields.io/pypi/v/django-harlequin.svg?style=for-the-badge\n :target: https://pypi.org/project/django-harlequin/\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge\n :target: https://github.com/psf/black\n\n.. image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white&style=for-the-badge\n :target: https://github.com/pre-commit/pre-commit\n :alt: pre-commit\n\nLaunch `Harlequin <https://harlequin.sh/>`__, the SQL IDE for your Terminal, with your Django database configuration.\n\n----\n\n**Work smarter and faster** with my book `Boost Your Django DX <https://adamchainz.gumroad.com/l/byddx>`__ which covers many tools to improve your development experience.\n\n----\n\nRequirements\n============\n\nPython 3.9 to 3.13 supported.\n\nDjango 4.2 to 5.2 supported.\n\nSupported database backends: MariaDB/MySQL, PostgreSQL, SQLite.\n\nInstallation\n============\n\n**First,** install with pip:\n\n.. code-block:: bash\n\n python -m pip install django-harlequin\n\n**Second,** install Harlequin with appropriate Harlequin `adapter packages <https://harlequin.sh/docs/adapters>`__ for the database backends you use.\nFor example, to install Harlequin with the `PostgreSQL adapter <https://harlequin.sh/docs/postgres/index>`__:\n\n.. code-block:: bash\n\n python -m pip install 'harlequin[postgres]'\n\nHarlequin does not need to be installed in the same virtual environment as Django, as django-harlequin does not import it.\nYou 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 <https://pipx.pypa.io/latest/installation/>`__.\n\n**Third,** add the app to your ``INSTALLED_APPS`` setting:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n ...,\n \"django_harlequin\",\n ...,\n ]\n\nUsage\n=====\n\n``harlequin`` command\n---------------------\n\nRun the ``harlequin`` management command to launch Harlequin, connected to your default database:\n\n.. code-block:: console\n\n $ ./manage.py harlequin\n\nPass ``--database`` to select a different database connection from ``settings.DATABASES``:\n\n.. code-block:: console\n\n $ ./manage.py harlequin --database replica\n\nExtra options, optionally after a ``--`` delimiter, will be passed through to Harlequin.\nFor example, to read its help page, as opposed to that of the management command:\n\n.. code-block:: console\n\n $ ./manage.py harlequin -- --help\n\nConfiguration\n=============\n\nHarlequin automatically loads configuration from ``pyproject.toml`` or its own files within the current working directory, which would mean next to your ``manage.py`` file.\nSee Harlequin\u2019s `configuration documentation <https://harlequin.sh/docs/config-file>`__ for details on the available options.\n",
"bugtrack_url": null,
"license": null,
"summary": "Launch Harlequin, the SQL IDE for your Terminal, with your Django database configuration.",
"version": "1.5.0",
"project_urls": {
"Changelog": "https://github.com/adamchainz/django-harlequin/blob/main/CHANGELOG.rst",
"Funding": "https://adamj.eu/books/",
"Repository": "https://github.com/adamchainz/django-harlequin"
},
"split_keywords": [
"django"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8b8299610792b5dba62f748b8a7a16ad699490c211d0cd3b627e62215093b216",
"md5": "af6cda9a5fe6d049448e3238e1abed52",
"sha256": "31afff3c6560738907693d8f0bba70e0bba0041db26b32c51a5c61cf104a6b38"
},
"downloads": -1,
"filename": "django_harlequin-1.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "af6cda9a5fe6d049448e3238e1abed52",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5817,
"upload_time": "2025-02-06T22:14:53",
"upload_time_iso_8601": "2025-02-06T22:14:53.237491Z",
"url": "https://files.pythonhosted.org/packages/8b/82/99610792b5dba62f748b8a7a16ad699490c211d0cd3b627e62215093b216/django_harlequin-1.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "a94935a2dd00a6859083bb5bea6602b9aa7a78a11ae9fbbb5a7715793ca24805",
"md5": "ed20f153be9c6a77756ec00edb406644",
"sha256": "b761fa158b4833e6ac03b1926e0ec217a90a364d683af28228c786e04c1bc219"
},
"downloads": -1,
"filename": "django_harlequin-1.5.0.tar.gz",
"has_sig": false,
"md5_digest": "ed20f153be9c6a77756ec00edb406644",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 7197,
"upload_time": "2025-02-06T22:14:54",
"upload_time_iso_8601": "2025-02-06T22:14:54.714001Z",
"url": "https://files.pythonhosted.org/packages/a9/49/35a2dd00a6859083bb5bea6602b9aa7a78a11ae9fbbb5a7715793ca24805/django_harlequin-1.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-06 22:14:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adamchainz",
"github_project": "django-harlequin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-harlequin"
}
