Skip to main content

A Python CLI for the Neon API

Project description

pyneoncli

A python package and command line tool for interaction with the Neon Serverless Postgres API.

This is a work in progress and this version is incomplete.

This version only supports the Neon V2 API.

The program can read the NEON_API_KEY from the environment or it can he loaded from a .env field in the current working directory.

Installation

You can install the package from PyPi using pip:

pip install pyneoncli

This will install the package and the command line tool. You can invoke the command line tool using the command neoncli.

Operation

usage: neoncli [-h] [--apikey APIKEY] [--version] [--nocolor] [--yes] [-f FIELDFILTER]
               {list,project,branch} ...

neoncli -  neon command line client

options:
  -h, --help            show this help message and exit
  --apikey APIKEY       Specify NEON API Key (env NEON_API_KEY)
  --version             show program's version number and exit
  --nocolor             Turn off Color output
  --yes                 Answer yes to all prompts
  -f FIELDFILTER, --fieldfilter FIELDFILTER
                        Enter field values to filter results on

subcommands:
  Invoke a specific neon command

  {list,project,branch}
                        e.g. neoncli list will list all projects
    list                List Neon objects
    project             Create and delete Neon projects
    branch              create and delete Neon branches

use neoncli list  -h for more information on the list command
use neoncli branch  -h for more information on the branch command
use neoncli project -h for more information on the project command

Version : 0.0.9a2

Project details


Download files

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

Source Distribution

pyneoncli-0.0.9a3.tar.gz (13.2 kB view hashes)

Uploaded Source

Built Distribution

pyneoncli-0.0.9a3-py3-none-any.whl (14.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page