Skip to content
/ porkpy Public

Porkpy 🐷 - CLI App to Interact With the Porkbun DNS API

License

Notifications You must be signed in to change notification settings

wjwat/porkpy

Repository files navigation

Code style: black Checked with mypy License: MIT

Porkpy 🐷 - CLI App to Interact With the Porkbun DNS API

It really cooks the bacon.

Easily manage your DNS records from the command line.

Example Screenshot

Features

  • Check prices for all available TLDs.
  • Check the price for any number of specific TLDs.
  • Test your API keys to make sure they work.
  • View records for an authorized domain.
  • Create new records for an authorized domain.
  • Delete records.
  • Currently unusable, please use the Porkbun web interface to edit a record. Edit records.

Usage

Currently Porkpy is developed and managed with Poetry.

  • Install Poetry
  • Clone this repo
  • In the directory where you have cloned this repo use poetry install to setup your environment.
  • Use poetry run python porkpy.py <commands> to use Porkpy.

To check the price of a TLD:

$ python porkpy.py pricing -t com | jq
{
  "status": "SUCCESS",
  "pricing": {
    "com": {
      "registration": "9.13",
      "renewal": "9.13",
      "transfer": "9.13",
      "coupons": {
        "registration": {
          "code": "AWESOMENESS",
          "max_per_user": 1,
          "first_year_only": "yes",
          "type": "amount",
          "amount": 1
        }
      }
    }
  }
}

Roadmap

  • Better testing, with full automation.
  • Provide docker image as well as executables.
  • Refactor, refactor, refactor.

About

Porkpy 🐷 - CLI App to Interact With the Porkbun DNS API

Resources

License

Stars

Watchers

Forks

Languages