# pkb_client Python client for the Porkbun API --- [![PyPI](https://img.shields.io/pypi/v/pkb_client)](https://pypi.org/project/pkb-client/) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pkb_client) [![Downloads](https://static.pepy.tech/personalized-badge/pkb-client?period=total&units=international_system&left_color=grey&right_color=orange&left_text=Total%20Downloads)](https://pepy.tech/project/pkb-client) ![GitHub](https://img.shields.io/github/license/infinityofspace/pkb_client) ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/infinityofspace/pkb_client/pypi-publish-release.yml) --- ### Table of Contents 1. [About](#about) 2. [Installation](#installation) 1. [With pip (recommend)](#with-pip-recommend) 2. [From source](#from-source) 3. [Usage](#usage) 4. [Notes](#notes) 5. [Third party notices](#third-party-notices) 6. [Development](#development) 1. [Setup environment](#setup-environment) 2. [Tests](#tests) 3. [Documentation](#documentation) 7. [License](#license) --- ### About *pkb_client* is a python client for the [Porkbun](https://porkbun.com) API. It supports the v3 of the API. You can find the official documentation of the Porkbun API [here](https://api.porkbun.com/api/json/v3/documentation). ### Installation This project only works with Python 3, make sure you have at least Python 3.9 installed. #### With pip (recommend) Use the following command to install *pkb_client* with pip: ```commandline pip3 install pkb_client ``` You can also very easily update to a newer version: ```commandline pip3 install pkb_client -U ``` #### From source ```commandline git clone https://github.com/infinityofspace/pkb_client.git cd pkb_client pip3 install . ``` ### Usage Each request must be made with the API key and secret. You can easily create them at Porkbun. Just follow the [official instructions](https://api.porkbun.com/api/json/v3/documentation#Authentication). Make sure that you explicitly activate the API usage for your domain at the end. There are two ways to use `pkb_client`. The first way is to use it as a Python module. See the [module documentation](https://infinityofspace.github.io/pkb_client) for more information. The second way is to use the module from the command line, see below for more information. After installation *pkb_client* is available under the command `pkb-client`. You have to specify your API key and secret each time as follows: ```commandline pkb-client -k -s ping ``` If you don't want to specify the key and secret in the program call, because for example the command line calls are logged, and you don't want to log the API access, then you can also set the environment variables `PKB_API_KEY` and `PKB_API_SECRET`. If you not specify API key and secret in any way, *pkb-client* asks for a user input. The command line arguments of the API key and secret have the highest priority. You can see an overview of all usable cli methods via the help: ```commandline pkb-client -h ``` If you need more help on a supported API method, you can use the following command, for example for the ping method: ```commandline pkb-client ping -h ``` #### Here are a few usage examples: Create a new TXT record for the subdomain `test` of the domain `example.com` with the value `porkbun is cool` and a TTL of `500`: ```commandline pkb-client -k -s dns-create example.com TXT "porkbun is cool" --name test --ttl 500 ``` The call returns the DNS record id. The record DNS ids are used to distinguish the DNS records and can be used for editing or deleting records. The ID is only a Porkbun internal identifier and is not publicly available. Delete the DNS record with the ID `12345` of the domain `example.com`: ```commandline pkb-client -k -s dns-delete example.com 12345 ``` Get all DNS records of the domain `example.com`: ```commandline pkb-client -k -s dns-retrieve example.com ``` Change the TXT DNS record content with the ID `456789` of the domain `example.com` to `the answer is 42`: ```commandline pkb-client -k -s dns-edit example.com 456789 TXT "the answer is 42" ``` Exporting all current DNS records of the domain `example.com` to the file `dns_recods.json`: ```commandline pkb-client -k -s dns-export example.com dns_recods.json ``` Remove all existing DNS records of the domain `example.com` and restore the DNS records from the file `dns_recods.json`: ```commandline pkb-client -k -s dns-import example.com dns_recods.json clear ``` *Note:* The `dns-import` function uses the record ID to distinguish DNS records. ### Notes Currently, TTL smaller than `600` are ignored by the Porkbun API and the minimum value is `600`, although a minimum value of `300` is [supported](https://api.porkbun.com/api/json/v3/documentation) and allowed by the RFC standard. However, you can do TTL smaller than `600` via the web dashboard. ### Third party notices All modules used by this project are listed below: | Name | License | |:-----------------------------------------------------:|:-------------------------------------------------------------------------------------------------:| | [requests](https://github.com/psf/requests) | [Apache 2.0](https://raw.githubusercontent.com/psf/requests/master/LICENSE) | | [setuptools](https://github.com/pypa/setuptools) | [MIT](https://raw.githubusercontent.com/pypa/setuptools/main/LICENSE) | | [sphinx](https://github.com/sphinx-doc/sphinx) | [BSD 2 Clause](https://raw.githubusercontent.com/sphinx-doc/sphinx/refs/heads/master/LICENSE.rst) | | [dnspython](https://github.com/rthalley/dnspython) | [ISC](https://raw.githubusercontent.com/rthalley/dnspython/refs/heads/main/LICENSEc) | | [responses](https://github.com/getsentry/responses) | [Apache 2.0](https://raw.githubusercontent.com/getsentry/responses/refs/heads/master/LICENSE) | | [ruff](https://github.com/astral-sh/ruff) | [MIT](https://raw.githubusercontent.com/astral-sh/ruff/refs/heads/main/LICENSE) | Furthermore, this readme file contains embeddings of [Shields.io](https://github.com/badges/shields) and [PePy](https://github.com/psincraian/pepy) images. _This project is not associated with Porkbun LLC._ ### Development #### Setup environment First get the source code: ```commandline git clone https://github.com/infinityofspace/pkb_client.git cd pkb_client ``` Now create a virtual environment, activate it and install all dependencies with the following commands: ```commandline python3 -m venv venv source venv/bin/activate pip3 install -r requirements.txt ``` Now you can start developing. Feel free to contribute to this project by creating a pull request. Before you create a pull request, make sure that you code meets the following requirements (you can use the specified commands to check/fulfill the requirements): - check unit tests: `python -m unittest tests/*.py` - format the code: `ruff format` - check linting errors: `ruff check` #### Tests You can run the tests with the following command: ```commandline python -m unittest tests/*.py ``` #### Documentation To build the documentation you can use the following commands: ```commandline sphinx-apidoc -f -o docs/source pkb_client cd docs && make html ``` ### License [MIT](https://github.com/infinityofspace/pkb_client/blob/master/License) - Copyright (c) Marvin Heptner