summaryrefslogtreecommitdiffstats
path: root/PKG-INFO
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-18 05:31:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-18 05:31:44 +0000
commitf77392695c09f9fef9386c112aef0e2b2f6fcd1a (patch)
tree04c428a7cfc9b7c6dbea73b5697f8c201d9106ff /PKG-INFO
parentInitial commit. (diff)
downloadpython-pgspecial-upstream.tar.xz
python-pgspecial-upstream.zip
Adding upstream version 2.1.2.upstream/2.1.2upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'PKG-INFO')
-rw-r--r--PKG-INFO110
1 files changed, 110 insertions, 0 deletions
diff --git a/PKG-INFO b/PKG-INFO
new file mode 100644
index 0000000..e4a0e1b
--- /dev/null
+++ b/PKG-INFO
@@ -0,0 +1,110 @@
+Metadata-Version: 2.1
+Name: pgspecial
+Version: 2.1.2
+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
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: SQL
+Classifier: Topic :: Database
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: click>=4.1
+Requires-Dist: sqlparse>=0.1.19
+Requires-Dist: psycopg>=3.0.10
+
+Meta-commands for Postgres
+--------------------------
+
+|Build Status| |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 file an issue if you need help.
+
+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.
+
+.. |Build Status| image:: https://github.com/dbcli/pgspecial/workflows/pgspecial/badge.svg
+ :target: https://github.com/dbcli/pgspecial/actions?query=workflow%3Apgspecial
+
+.. |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