blob: e4a0e1b0b32483e1cada2fc8ab77b5dabfb3fb81 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
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
|
