infinityofspace / pkb_client

Python client for the Porkbun API

About me

I studied machine learning and intelligent systems. Moreover, I am a big fan of open source, python and self-hosting.

Skills

• languages: Python 3, Java, C/C#/C++, HTML, JavaScript, Assembly, SQL, Haskell
• frameworks: PyTorch, TensorFlow, scikit-learn, Matplotlib, NumPy, pandas, OpenCV, DGL, flask, nginx, Android, Spring, JPA
• tools and utilities: git, linux, docker, snap, Blender, Unity

Projects

You can find some of my project highlights with a summary here.

pkb_client's Issues

Feature: add support for domain functionality API methods

Currently the client does not support the new domain functionality API methods.
The new methods can be found here in the "Domain Functionality" section.
Among other things, it allows you to change the nameservers and retrieve the domains of an account.

Implementation notes

To support the new API methods, the current API client can be extended with the same structure as the currently supported API methods.

Remove "unofficial" wording from the description

Context:

Currently the description contains the "unofficial" wording to clarify the independence of Porkbun LLC, but this is misleading for readers. The addition implies that a non-official API is used and not that the project is not associated with Porkbun LLC.

Solution:

We should remove the "unofficial" statements and use a This project is not associated with Porkbun LLC statement instead.

Add support for the domain pricing API

The Porkbun API v3 supports the domain prices, this is currently not implemented in the client.

Replace the current tests of the API calls with dummy requests

Please describe which problem should be solved

Currently, the tests are performed directly in the productive environment, which prevents automatic testing in the CI.

Optional: Describe your idea for a solution

The current tests must be replaced by a dummy server API. This allows the tests to be run as a step during the CI.

Replace return values of the API client with objects

Please describe which problem should be solved

Replace return values of the API with objects instead of python dicts, this allows easier use of the client as a library.

Add code documentation and type hints

Drop support for unsupported Python versions and support newer versions

The support for Python 3.6 and 3.7 has ended in December 2021 and June 2023.
Due to the lack of official support, the project should end official support for these versions.
In addition, official support for the new Python versions 3.11 and 3.12 should be added.

Wrong name in the cli for dns retrieve api call

The cli uses the argument dns-receive to get all DNS records. The argument name should match the client method name and the API name which is dns-retrieve.

The command result in case of an error should return only the message instead of the entire response value

The status value in the response is not helpful in case of an error and can be omitted.

DNS API: Add support for export and import of DNS records

It would be very helpful if you could backup the current DNS records and have them restored later if needed.

When importing again, there should be several modes for handling already existing same DNS entries.
Ideas for modes:

• remove all current DNS records and import the exported records
• replace existing DNS records with the same name and type with the exported records
• keep existing DNS records but import all other

Add support for new DNS record API methods

Please describe which problem should be solved

The following new DNS API methods are currently not unsupported:

• DNS Edit Records by Domain, Subdomain and Type
• DNS Delete Records by Domain, Subdomain and Type
• DNS Retrieve Records by Domain or ID
• DNS Retrieve Records by Domain, Subdomain and Type

The new API methods should be supported by the client, as they provide additional value in contrast to the previous API methods, such as selection by domain instead of DNS record ID.

Optional: Describe your idea for a solution

(Write your answer here.)

Add module usage examples

Please describe which problem should be solved

The current documentation does not describe its use as a module. This should be added to make it easier to use.

Optional: Describe your idea for a solution

Add the usage examples to the examples sections in the readme.

Add support for SSL retrieve bundle API

The Porkbun API v3 supports receiving the SSL bundle, this is currently not implemented in the client.

Build docs from pydocs and host them on Github pages

Please describe which problem should be solved

At the moment, the pydocs are only available in source code, which makes them difficult to access and read.

Optional: Describe your idea for a solution

Pydocs should be build automatically with Github actions and hosted on Github pages for easier access.