summaryrefslogtreecommitdiffstats
path: root/docs/source/index.rst
blob: 46f8eb14112c5a356c5b504e05793dc2386dac6a (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
Welcome to pkb_client's documentation!
======================================

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   installation
   usage
   modules
   migration_guide

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>`_.

Link to the source code: `Github <https://github.com/infinityofspace/pkb_client>`_

*Note:* This project is not associated with Porkbun LLC.


Indices and tables
++++++++++++++++++

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`