v2.0.0

Changelog

⚠️ This release contains breaking changes ⚠️

This version of the package is a major release that introduces a lot of internal and external changes which are not compatible to version 1. This includes methods renames and argument changes.

Please check out the migration guide for more information.

❗ Porkbun API endpoint changes ❗

The Porkbun API domain roots changes on 2024-12-01 00:00:00 UTC (see #39 (comment)). Please update to this version v2.0.0 or later, which includes the new API endpoint, to avoid any issues.

New features highlights

• Makefile to autobuild on RedHat systems by @VenaNocta in #11
• Update Porkbun API domain root to api.porkbun.com by @sdrothrock in #39
• Support for BIND zone file import and export
• Support for environment secrets
• Package docs are now available at https://infinityofspace.github.io/pkb_client/
• Support for python 3.10, 3.11, 3.12, 3.13
• Drop support for python 3.6, 3.7, 3.8
• Support for new DNS API methods:
  • DNS Functionality
    • 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
  • Domain Functionality
    • Domain Update Name Servers
    • Domain Get Name Servers
    • Domain List All
    • Domain Add Url Forward
    • Domain Get URL Forwarding
    • Domain Delete Url Forward
  • Now all DNS endpoints are available in the client
• Improved error handling and logging
• Improved code tests

Installation

You can install this specific version with:

pip install pkb-client==2.0.0

What's Changed

• Bump actions/setup-python from 2 to 3 by @dependabot in #7
• Bump actions/download-artifact from 2 to 3 by @dependabot in #9
• Bump actions/upload-artifact from 2 to 3 by @dependabot in #8
• Bump actions/setup-python from 3 to 4 by @dependabot in #10
• Bump actions/setup-python from 4 to 5 by @dependabot in #16
• Bump actions/download-artifact from 3 to 4 by @dependabot in #19
• Bump actions/upload-artifact from 3 to 4 by @dependabot in #18
• Bump actions/upload-artifact from 3 to 4 by @dependabot in #22
• Bump actions/download-artifact from 3 to 4 by @dependabot in #23
• Bump peter-evans/create-pull-request from 5 to 6 by @dependabot in #24
• Bump actions/setup-python from 5.0.0 to 5.1.0 by @dependabot in #25
• replaced unofficial wording in the descriptions closes #26 by @infinityofspace in #27
• Bump peaceiris/actions-gh-pages from 3 to 4 by @dependabot in #28
• Bump actions/setup-python from 5.1.0 to 5.1.1 by @dependabot in #31
• Bump actions/setup-python from 5.1.1 to 5.2.0 by @dependabot in #35
• Bump peter-evans/create-pull-request from 6 to 7 by @dependabot in #36
• [deadline: 2024-12-01 00:00:00 UTC] Update Porkbun API domain root to api.porkbun.com by @sdrothrock in #39
• Update dnspython requirement from ~=2.6 to ~=2.7 by @dependabot in #37
• Bump actions/setup-python from 5.2.0 to 5.3.0 by @dependabot in #41
• Update sphinx requirement from ~=7.0 to ~=7.4 by @dependabot in #42
• Feature: Makefile to autobuild python3-pkb-client by @VenaNocta in #11

New Contributors

• @dependabot made their first contribution in #7
• @sdrothrock made their first contribution in #39
• @VenaNocta made their first contribution in #11

Full Changelog: v1.2...v2.0.0

v1.2

Changelog

New features

• added support to get porkbun domain pricing #5
• added support to retrieve the ssl bundle #6

Installation

You can install this specific version with:

pip install pkb-client==1.2

v1.1

Changelog

New features

• added support for importing and exporting dns records #4

Fixes

• the error message only contains the error message not the whole request response #3

Changes

• renamed the cli command argument dns-receive to dns-retrieve #2

Other

• added missing code documentation and type hints #1
• fixed typos in Readme
• added more usage examples

Installation

You can install this specific version with:

pip install pkb-client==1.1

v1.0

First release of pkb_client