Skip to content

pgxn/pgxnclient

Repository files navigation

PGXN Client

A command line tool to interact with the PostgreSQL Extension Network

The PGXN Client is a command line tool designed to interact with the PostgreSQL Extension Network allowing searching, compiling, installing, and removing extensions in PostgreSQL databases.

For example, to install the semver extension, the client can be invoked as:

$ pgxn install semver

which would download and compile the extension for one of the PostgreSQL servers hosted on the machine and:

$ pgxn load -d somedb semver

which would load the extension in one of the databases of the server.

The client interacts with the PGXN web service and a Makefile provided by the extension. The best results are achieved with makefiles using the PostgreSQL Extension Building Infrastructure; however the client tries to degrade gracefully in presence of any package hosted on PGXN.

Please refer to the files in the docs directory or online for instructions about the program installation and usage.

Development

You can create a local development environment with:

virtualenv .venv
source .venv/bin/activate
pip install -e .[dev]

and run pytest to run the test suite.