pgtoolkit


Namepgtoolkit JSON
Version 0.28.0 PyPI version JSON
download
home_pagehttps://github.com/dalibo/pgtoolkit
SummaryPostgreSQL Support from Python
upload_time2024-03-04 08:59:46
maintainer
docs_urlNone
authorDalibo
requires_python>=3.9
licensePostgreSQL
keywords postgresql postgresql.conf pg_hba pgpass pg_service.conf
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ####################################
 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 <https://github.com/dalibo/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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/dalibo/pgtoolkit",
    "name": "pgtoolkit",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "postgresql postgresql.conf pg_hba pgpass pg_service.conf",
    "author": "Dalibo",
    "author_email": "contact@dalibo.com",
    "download_url": "https://files.pythonhosted.org/packages/ff/d4/18480d2581aaeb0945163472f5b989d02f3ccdd77c6269301080c1b62aad/pgtoolkit-0.28.0.tar.gz",
    "platform": null,
    "description": "####################################\n Postgres Cluster Support in Python\n####################################\n\n| |Tests status| |Codecov| |RTD|\n\n\n``pgtoolkit`` provides implementations to manage various file formats in Postgres\ncluster. Currently:\n\n- ``postgresql.conf``: read, edit, save.\n- ``pg_hba.conf``: render, validate and align columns.\n- ``.pgpass``: render, validate and sort lines.\n- ``pg_service.conf``: find, read, edit, render.\n- Cluster logs.\n\nIt also provides a Python API for calling pg_ctl_ commands.\n\n.. _pg_ctl: https://www.postgresql.org/docs/current/app-pg-ctl.html\n\n\n.. code::\n\n   import sys\n\n   from pgtoolkit.hba import parse\n\n\n   with open('pg_hba.conf') as fo:\n       hba = parse(fo)\n\n   hba.write(sys.stdout)\n\n\nThe API in this toolkit must:\n\n- Use only Python stdlib.\n- Use Postgres idioms.\n- Have full test coverage.\n- Run everywhere.\n\n\nSupport\n-------\n\n`pgtoolkit <https://github.com/dalibo/pgtoolkit>`_ home on GitHub is the unique\nway of interacting with developers. Feel free to open an issue to get support.\n\n\n.. |Codecov| image:: https://codecov.io/gh/dalibo/pgtoolkit/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/dalibo/pgtoolkit\n   :alt: Code coverage report\n\n.. |Tests status| image:: https://github.com/dalibo/pgtoolkit/actions/workflows/tests.yml/badge.svg\n   :target: https://github.com/dalibo/pgtoolkit/actions/workflows/tests.yml\n   :alt: Continuous Integration report\n\n.. |RTD| image:: https://readthedocs.org/projects/pgtoolkit/badge/?version=latest\n   :target: https://pgtoolkit.readthedocs.io/en/latest/\n   :alt: Documentation\n",
    "bugtrack_url": null,
    "license": "PostgreSQL",
    "summary": "PostgreSQL Support from Python",
    "version": "0.28.0",
    "project_urls": {
        "Homepage": "https://github.com/dalibo/pgtoolkit"
    },
    "split_keywords": [
        "postgresql",
        "postgresql.conf",
        "pg_hba",
        "pgpass",
        "pg_service.conf"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8dad3adf0b355f3e1d4e61dad6a585d8115df09e5a5b42f61e7a3c3bc7859787",
                "md5": "cfc7aabc0767fa686ef1b64df1a6bb7f",
                "sha256": "1e13968e848be842651e06efea9aede0b9ffb9d7ecb5e9256f00888e23c254bc"
            },
            "downloads": -1,
            "filename": "pgtoolkit-0.28.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfc7aabc0767fa686ef1b64df1a6bb7f",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 35900,
            "upload_time": "2024-03-04T08:59:44",
            "upload_time_iso_8601": "2024-03-04T08:59:44.720047Z",
            "url": "https://files.pythonhosted.org/packages/8d/ad/3adf0b355f3e1d4e61dad6a585d8115df09e5a5b42f61e7a3c3bc7859787/pgtoolkit-0.28.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ffd418480d2581aaeb0945163472f5b989d02f3ccdd77c6269301080c1b62aad",
                "md5": "b30773edbb787ccedeb0cdfbc9790850",
                "sha256": "8e0200c02687d033fd4c717ba66a07437ad860246a1e7b634aad008d94deb5f4"
            },
            "downloads": -1,
            "filename": "pgtoolkit-0.28.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b30773edbb787ccedeb0cdfbc9790850",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 56697,
            "upload_time": "2024-03-04T08:59:46",
            "upload_time_iso_8601": "2024-03-04T08:59:46.482820Z",
            "url": "https://files.pythonhosted.org/packages/ff/d4/18480d2581aaeb0945163472f5b989d02f3ccdd77c6269301080c1b62aad/pgtoolkit-0.28.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-04 08:59:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dalibo",
    "github_project": "pgtoolkit",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pgtoolkit"
}
        
Elapsed time: 0.21826s