Skip to main content

Library for getting passwords from PostgreSQL password files

Project description

pgpasslib is a library for retrieving passwords from a PostgreSQL password file, either from a location specified in the PGPASSFILE environment variable or in the .pgpass file in the current user’s home directory.

Version Downloads Status Coverage Code Climate


pgpasslib may be installed via the Python package index with the tool of your choice. I prefer pip:

pip install pgpasslib


There are no requirements outside of the Python standard library.


The following example will attempt to get the password for PostgreSQL running on localhost:5432 to the postgres database as the postgres user.

import pgpasslib

password = pgpasslib.getpass('localhost', 5432, 'postgres', 'postgres')
if not password:
    raise ValueError('Did not find a password in the .pgpass file')

Version History

Available at

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pgpasslib, version 1.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pgpasslib-1.1.0-py2.py3-none-any.whl (7.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pgpasslib-1.1.0.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page