Metadata-Version: 1.1
Name: pgspecial
Version: 1.11.10
Summary: Meta-commands handler for Postgres Database.
Home-page: https://www.dbcli.com
Author: Pgcli Core Team
Author-email: pgcli-dev@googlegroups.com
License: LICENSE.txt
Description: Meta-commands for Postgres
        --------------------------
        
        |BuildStatus|  |PyPI|
        
        This package provides an API to execute meta-commands (AKA "special", or
        "backslash commands") on PostgreSQL.
        
        Quick Start
        -----------
        
        This is a python package. It can be installed with:
        
        ::
        
            $ pip install pgspecial
        
        
        Usage
        -----
        
        Once this library is included into your project, you will most likely use the
        following imports:
        
        .. code-block:: python
        
            from pgspecial.main import PGSpecial
            from pgspecial.namedqueries import NamedQueries
        
        Then you will create and use an instance of PGSpecial:
        
        .. code-block:: python
        
                pgspecial = PGSpecial()
                for result in pgspecial.execute(cur, sql):
                    # Do something
        
        If you want to import named queries from an existing config file, it is
        convenient to initialize and keep around the class variable in
        ``NamedQueries``:
        
        .. code-block:: python
        
            from configobj import ConfigObj
        
            NamedQueries.instance = NamedQueries.from_config(
                ConfigObj('~/.config_file_name'))
        
        Contributions:
        --------------
        
        If you're interested in contributing to this project, first of all I would like
        to extend my heartfelt gratitude. I've written a small doc to describe how to
        get this running in a development setup.
        
        https://github.com/dbcli/pgspecial/blob/master/DEVELOP.rst
        
        Please feel free to reach out if you need help.
        
        mailing list: https://groups.google.com/forum/#!forum/pgcli
        
        Projects using it:
        ------------------
        
        This library is used by the following projects:
        
        pgcli_: A REPL for Postgres.
        
        `ipython-sql`_: %%sql magic for IPython
        
        OmniDB_: An web tool for database management
        
        If you find this module useful and include it in your project, I'll be happy
        to know about it and list it here.
        
        .. |BuildStatus| image:: https://api.travis-ci.org/dbcli/pgspecial.svg?branch=master
            :target: https://travis-ci.org/dbcli/pgspecial
        
        .. |PyPI| image:: https://badge.fury.io/py/pgspecial.svg
            :target: https://pypi.python.org/pypi/pgspecial/
            :alt: Latest Version
        
        .. _pgcli: https://github.com/dbcli/pgcli
        .. _`ipython-sql`: https://github.com/catherinedevlin/ipython-sql
        .. _OmniDB: https://github.com/OmniDB/OmniDB
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: SQL
Classifier: Topic :: Database
Classifier: Topic :: Database :: Front-Ends
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries :: Python Modules
