Overview

docs

Documentation Status

build

GitHub Actions Build Status Coverage Status

package

PyPI Package license PyPI Package latest release PyPI Wheel Supported Python versions
Commits since latest release

CLI client for managing domain DNS records through calls to Porkbun API. It can create, edit and list DNS records following a configuration provided in a YAML file. The client is flexible and can restrict its operations to only a subset choosen by the user by supporting several operation modes:

  • append – only new entries are created preserving existing entries unchanged

  • replace – replace all existing entries with user configuration

  • update – only update existing entries without creating or removing entries that are not listed in the configuration

  • upgrade – create new entries or update exising but do not remove entries that are not listed in the configuration

It depends on other common packages:

  • click

  • pyyaml

  • requests

Installation

Get latest released version from PyPI:

pip install porkbun-api-cli

You can also install the in-development version with:

pip install https://github.com/breezerider/porkbun-api-cli/archive/main.zip

Documentation

https://porkbun-api-cli.readthedocs.io/

License

Development

To run all the tests issue this command in a terminal:

tox