https://github.com/dalibo/pgtoolkit

Postgres Support from Python
https://github.com/dalibo/pgtoolkit

hba pgpass postgres postgresql python

Last synced: about 2 months ago
JSON representation

Postgres Support from Python

• Host: GitHub
• URL: https://github.com/dalibo/pgtoolkit
• Owner: dalibo
• License: postgresql
• Created: 2018-06-08T10:28:54.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-04T08:59:18.000Z (10 months ago)
• Last Synced: 2024-05-10T00:17:51.303Z (8 months ago)
• Topics: hba, pgpass, postgres, postgresql, python
• Language: Python
• Homepage: https://pgtoolkit.rtfd.io/
• Size: 495 KB
• Stars: 21
• Watchers: 16
• Forks: 8
• Open Issues: 3
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
####################################

 Postgres Cluster Support in Python

####################################

| |Tests status| |Codecov| |RTD|

``pgtoolkit`` provides implementations to manage various file formats in Postgres

cluster. Currently:

- ``postgresql.conf``: read, edit, save.

- ``pg_hba.conf``: render, validate and align columns.

- ``.pgpass``: render, validate and sort lines.

- ``pg_service.conf``: find, read, edit, render.

- Cluster logs.

It also provides a Python API for calling pg_ctl_ commands.

.. _pg_ctl: https://www.postgresql.org/docs/current/app-pg-ctl.html

.. code::

   import sys

   from pgtoolkit.hba import parse

   with open('pg_hba.conf') as fo:

       hba = parse(fo)

   hba.write(sys.stdout)

The API in this toolkit must:

- Use only Python stdlib.

- Use Postgres idioms.

- Have full test coverage.

- Run everywhere.

Support

-------

`pgtoolkit `_ home on GitHub is the unique

way of interacting with developers. Feel free to open an issue to get support.

.. |Codecov| image:: https://codecov.io/gh/dalibo/pgtoolkit/branch/master/graph/badge.svg

   :target: https://codecov.io/gh/dalibo/pgtoolkit

   :alt: Code coverage report

.. |Tests status| image:: https://github.com/dalibo/pgtoolkit/actions/workflows/tests.yml/badge.svg

   :target: https://github.com/dalibo/pgtoolkit/actions/workflows/tests.yml

   :alt: Continuous Integration report

.. |RTD| image:: https://readthedocs.org/projects/pgtoolkit/badge/?version=latest

   :target: https://pgtoolkit.readthedocs.io/en/latest/

   :alt: Documentation