Metadata-Version: 2.4
Name: django-pgcli5
Version: 1.0.1
Summary: Database runtime for Django that replaces psql with pgcli.
Project-URL: Homepage, https://github.com/offbyone/django-pgcli5
Author-email: Chris R <offline@offby1.net>, Ash Christopher <ash.christopher@gmail.com>
License: BSD
License-File: AUTHORS.md
License-File: LICENSE
Keywords: django pgcli postgres database
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.10
Requires-Dist: django>=5
Requires-Dist: pgcli
Requires-Dist: psycopg
Description-Content-Type: text/markdown

# django-pgcli5

[![Build Status](https://github.com/offbyone/django-pgcli/actions/workflows/ci.yml/badge.svg)](https://github.com/offbyone/django-pgcli/actions/workflows/ci.yml)

[![PyPI version](https://badge.fury.io/py/django-pgcli5.svg)](https://badge.fury.io/py/django-pgcli5) 

![PyPI - License](https://img.shields.io/pypi/l/django-pgcli5)

Replaces your existing *psql* cli for Postgres with *pgcli* which provides enhancements such as auto-completion and syntax highlighting. Visit the [pgcli website](https://www.pgcli.com/) to learn more about the **pgcli** client.

## Installation

To install the package:

    `pip install django-pgcli5`

Add `django_pgcli5` to your `INSTALLED_APPS` setting in your settings.py file.

    INSTALLED_APPS = [
        ...,
        'django_pgcli5',
    ]

## Usage

To use the `pgcli` command with your project, call the `dbshell` command.

    ./manage.py dbshell
