PyPI - libknot - Versions diffs - 3.3.13.dev0__tar.gz → 3.3.14.dev0__tar.gz - Mend

libknot 3.3.13.dev0tar.gz → 3.3.14.dev0tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

{libknot-3.3.13.dev0 → libknot-3.3.14.dev0}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libknot
-Version: 3.3.13.dev0
+Version: 3.3.14.dev0
 Summary: Python bindings for libknot
 Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
 Author: CZ.NIC, z.s.p.o.
@@ -28,10 +28,10 @@ A Python interface for managing the Knot DNS daemon.
 * [Introduction](#introduction)
 * [Control module](#control-module)
-  + [Control usage](#control-usage)
-  + [CTL protocol reference](#kctl-proto)
-  + [CTL commands reference](#kctl-cmds)
-  + [Control examples](#control-examples)
+  + [Usage](#control-usage)
+  + [Protocol reference](#kctl-proto)
+  + [Commands reference](#kctl-cmds)
+  + [Examples](#control-examples)
 * [Probe module](#probe-module)
   + [Probe usage](#probe-usage)
   + [Probe examples](#probe-examples)
@@ -68,7 +68,7 @@ The module usage consists of several steps:
   afterwards.
 * Closing the connection and deinitialization.
-### KnotCTL protocol overview<a id="kctl-proto"></a>
+### Protocol overview<a id="kctl-proto"></a>
 Connections are supposed to be short-lived, because maintaining a passive
 connection is costly for the server. Therefore the expected usage of the ctl
@@ -107,22 +107,21 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | `DATA`       | Configuration item/zone record data.                   |
 | `FILTERS`    | Command options or filters for output data processing. |
-### CTL commands reference<a id="kctl-cmds"></a>
+### Commands reference<a id="kctl-cmds"></a>
 The following is a reference for the low-level CTL API. In case you're unsure
 of the commands' semantics, please consult the
-<a href="https://knot.pages.nic.cz/knot-dns/master/html/man_knotc.html#actions">knotc documentation</a>.
+<a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 A concise notation is used for command synopsis:
 <pre>
-cmd-name(SECTION_NAME:section's purpouse,
-    [OPTIONAL_SECTION="literal value":literal's purpouse],
+cmd-name(SECTION_NAME,
+    [OPTIONAL_SECTION="literal value"],
     [OPT_SECTION1, OPT_SECTION2],      # Sections must be present together or not at all
     [OPT_MASTER, [OPT_SLAVE]],         # OPT_SLAVE may only appear if OPT_MASTER is present
     SECTION_NAME2="option1"|"option2", # Either one or the other literal may be used
     SECTION_NAME3={"asdf"},            # any subset of characters
-    SECTION_NAME4="a":flag's purpouse,"s","d","f" # any subset of characters
 )
 </pre>
@@ -133,7 +132,9 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `stats([SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Zone events
@@ -141,13 +142,16 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `zone-status([ZONE], [FILTERS={"rstefc"}])`
   + `FILTERS`: role `(r)`, serial `(s)`, transaction `(t)`, events `(e)`, freeze `(f)`, catalog `(c)`
-* `zone-reload([ZONE], [FLAGS={"B","F":reload modules}])`
+* `zone-reload([ZONE], [FLAGS={"BF"}])`
+  + `FLAGS`: `F` reload modules
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA:output directory], [FLAGS="B"])`
-* `zone-backup([ZONE], [FILTERS={"dzjtkocq"}, [DATA:output dir for "d" filter]], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+  + the outputdir `(d)` filter commands that zone(s) be flushed to path stored in the `DATA` section
+* `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + `FILTERS`
+    - for description of the outputdir `(d)` filter see `zone-flush`
     - zonefile `(z)`, journal `(j)`, timers `(t)`, kaspdb `(k)`, keysonly `(o)`, catalog `(c)`, quic `(q)`
     - negative counterparts (eg. `nozonefile`) are symmetrical and capitalized
 * `zone-restore` <i>analogous to `zone-backup`</i>
@@ -165,7 +169,8 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
-* `zone-read([ZONE:if none read all], [OWNER], [TYPE])`
+* `zone-read([ZONE], [OWNER], [TYPE])`
+  + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE)`
 * `zone-commit(ZONE)`
 * `zone-abort(ZONE)`
@@ -175,7 +180,9 @@ Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
 * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
 * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
   + `FILTERS`: orphan `(o)`, catalog `(c)`, expire `(e)`, journal `(j)`, kaspdb `(k)`, timers `(t)`, zonefile `(f)`
-* `zone-stats(ZONE, [SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Configuration

{libknot-3.3.13.dev0 → libknot-3.3.14.dev0}/README.md RENAMED Viewed

@@ -6,10 +6,10 @@ A Python interface for managing the Knot DNS daemon.
 * [Introduction](#introduction)
 * [Control module](#control-module)
-  + [Control usage](#control-usage)
-  + [CTL protocol reference](#kctl-proto)
-  + [CTL commands reference](#kctl-cmds)
-  + [Control examples](#control-examples)
+  + [Usage](#control-usage)
+  + [Protocol reference](#kctl-proto)
+  + [Commands reference](#kctl-cmds)
+  + [Examples](#control-examples)
 * [Probe module](#probe-module)
   + [Probe usage](#probe-usage)
   + [Probe examples](#probe-examples)
@@ -46,7 +46,7 @@ The module usage consists of several steps:
   afterwards.
 * Closing the connection and deinitialization.
-### KnotCTL protocol overview<a id="kctl-proto"></a>
+### Protocol overview<a id="kctl-proto"></a>
 Connections are supposed to be short-lived, because maintaining a passive
 connection is costly for the server. Therefore the expected usage of the ctl
@@ -85,22 +85,21 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | `DATA`       | Configuration item/zone record data.                   |
 | `FILTERS`    | Command options or filters for output data processing. |
-### CTL commands reference<a id="kctl-cmds"></a>
+### Commands reference<a id="kctl-cmds"></a>
 The following is a reference for the low-level CTL API. In case you're unsure
 of the commands' semantics, please consult the
-<a href="https://knot.pages.nic.cz/knot-dns/master/html/man_knotc.html#actions">knotc documentation</a>.
+<a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 A concise notation is used for command synopsis:
 <pre>
-cmd-name(SECTION_NAME:section's purpouse,
-    [OPTIONAL_SECTION="literal value":literal's purpouse],
+cmd-name(SECTION_NAME,
+    [OPTIONAL_SECTION="literal value"],
     [OPT_SECTION1, OPT_SECTION2],      # Sections must be present together or not at all
     [OPT_MASTER, [OPT_SLAVE]],         # OPT_SLAVE may only appear if OPT_MASTER is present
     SECTION_NAME2="option1"|"option2", # Either one or the other literal may be used
     SECTION_NAME3={"asdf"},            # any subset of characters
-    SECTION_NAME4="a":flag's purpouse,"s","d","f" # any subset of characters
 )
 </pre>
@@ -111,7 +110,9 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `stats([SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Zone events
@@ -119,13 +120,16 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `zone-status([ZONE], [FILTERS={"rstefc"}])`
   + `FILTERS`: role `(r)`, serial `(s)`, transaction `(t)`, events `(e)`, freeze `(f)`, catalog `(c)`
-* `zone-reload([ZONE], [FLAGS={"B","F":reload modules}])`
+* `zone-reload([ZONE], [FLAGS={"BF"}])`
+  + `FLAGS`: `F` reload modules
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA:output directory], [FLAGS="B"])`
-* `zone-backup([ZONE], [FILTERS={"dzjtkocq"}, [DATA:output dir for "d" filter]], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+  + the outputdir `(d)` filter commands that zone(s) be flushed to path stored in the `DATA` section
+* `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + `FILTERS`
+    - for description of the outputdir `(d)` filter see `zone-flush`
     - zonefile `(z)`, journal `(j)`, timers `(t)`, kaspdb `(k)`, keysonly `(o)`, catalog `(c)`, quic `(q)`
     - negative counterparts (eg. `nozonefile`) are symmetrical and capitalized
 * `zone-restore` <i>analogous to `zone-backup`</i>
@@ -143,7 +147,8 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
-* `zone-read([ZONE:if none read all], [OWNER], [TYPE])`
+* `zone-read([ZONE], [OWNER], [TYPE])`
+  + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE)`
 * `zone-commit(ZONE)`
 * `zone-abort(ZONE)`
@@ -153,7 +158,9 @@ Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
 * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
 * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
   + `FILTERS`: orphan `(o)`, catalog `(c)`, expire `(e)`, journal `(j)`, kaspdb `(k)`, timers `(t)`, zonefile `(f)`
-* `zone-stats(ZONE, [SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Configuration

{libknot-3.3.13.dev0 → libknot-3.3.14.dev0}/libknot.egg-info/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: libknot
-Version: 3.3.13.dev0
+Version: 3.3.14.dev0
 Summary: Python bindings for libknot
 Home-page: https://gitlab.nic.cz/knot/knot-dns/-/tree/master/python/libknot
 Author: CZ.NIC, z.s.p.o.
@@ -28,10 +28,10 @@ A Python interface for managing the Knot DNS daemon.
 * [Introduction](#introduction)
 * [Control module](#control-module)
-  + [Control usage](#control-usage)
-  + [CTL protocol reference](#kctl-proto)
-  + [CTL commands reference](#kctl-cmds)
-  + [Control examples](#control-examples)
+  + [Usage](#control-usage)
+  + [Protocol reference](#kctl-proto)
+  + [Commands reference](#kctl-cmds)
+  + [Examples](#control-examples)
 * [Probe module](#probe-module)
   + [Probe usage](#probe-usage)
   + [Probe examples](#probe-examples)
@@ -68,7 +68,7 @@ The module usage consists of several steps:
   afterwards.
 * Closing the connection and deinitialization.
-### KnotCTL protocol overview<a id="kctl-proto"></a>
+### Protocol overview<a id="kctl-proto"></a>
 Connections are supposed to be short-lived, because maintaining a passive
 connection is costly for the server. Therefore the expected usage of the ctl
@@ -107,22 +107,21 @@ The data section identifiers are defined in `libknot.control.KnotCtlDataIdx`:
 | `DATA`       | Configuration item/zone record data.                   |
 | `FILTERS`    | Command options or filters for output data processing. |
-### CTL commands reference<a id="kctl-cmds"></a>
+### Commands reference<a id="kctl-cmds"></a>
 The following is a reference for the low-level CTL API. In case you're unsure
 of the commands' semantics, please consult the
-<a href="https://knot.pages.nic.cz/knot-dns/master/html/man_knotc.html#actions">knotc documentation</a>.
+<a href="https://www.knot-dns.cz/docs/latest/singlehtml/index.html#actions">knotc documentation</a>.
 A concise notation is used for command synopsis:
 <pre>
-cmd-name(SECTION_NAME:section's purpouse,
-    [OPTIONAL_SECTION="literal value":literal's purpouse],
+cmd-name(SECTION_NAME,
+    [OPTIONAL_SECTION="literal value"],
     [OPT_SECTION1, OPT_SECTION2],      # Sections must be present together or not at all
     [OPT_MASTER, [OPT_SLAVE]],         # OPT_SLAVE may only appear if OPT_MASTER is present
     SECTION_NAME2="option1"|"option2", # Either one or the other literal may be used
     SECTION_NAME3={"asdf"},            # any subset of characters
-    SECTION_NAME4="a":flag's purpouse,"s","d","f" # any subset of characters
 )
 </pre>
@@ -133,7 +132,9 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `status([TYPE="cert-key"|"configure"|"version"|"workers"])`
 * `stop()`
 * `reload()`
-* `stats([SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `stats([SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Zone events
@@ -141,13 +142,16 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 * `zone-status([ZONE], [FILTERS={"rstefc"}])`
   + `FILTERS`: role `(r)`, serial `(s)`, transaction `(t)`, events `(e)`, freeze `(f)`, catalog `(c)`
-* `zone-reload([ZONE], [FLAGS={"B","F":reload modules}])`
+* `zone-reload([ZONE], [FLAGS={"BF"}])`
+  + `FLAGS`: `F` reload modules
 * `zone-refresh([ZONE], [FLAGS="B"])`
 * `zone-retransfer([ZONE], [FLAGS="B"])`
 * `zone-notify([ZONE], [FLAGS="B"])`
-* `zone-flush([ZONE], [FILTERS="d", DATA:output directory], [FLAGS="B"])`
-* `zone-backup([ZONE], [FILTERS={"dzjtkocq"}, [DATA:output dir for "d" filter]], [FLAGS="B"])`
+* `zone-flush([ZONE], [FILTERS="d", DATA], [FLAGS="B"])`
+  + the outputdir `(d)` filter commands that zone(s) be flushed to path stored in the `DATA` section
+* `zone-backup([ZONE], [FILTERS={"dzjtkocqZJTKOCQ"}, [DATA]], [FLAGS="B"])`
   + `FILTERS`
+    - for description of the outputdir `(d)` filter see `zone-flush`
     - zonefile `(z)`, journal `(j)`, timers `(t)`, kaspdb `(k)`, keysonly `(o)`, catalog `(c)`, quic `(q)`
     - negative counterparts (eg. `nozonefile`) are symmetrical and capitalized
 * `zone-restore` <i>analogous to `zone-backup`</i>
@@ -165,7 +169,8 @@ The **`"B"`** flag always represents an option to execute in blocking mode.
 Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
-* `zone-read([ZONE:if none read all], [OWNER], [TYPE])`
+* `zone-read([ZONE], [OWNER], [TYPE])`
+  + if `ZONE` is left empty all zones are read
 * `zone-begin(ZONE)`
 * `zone-commit(ZONE)`
 * `zone-abort(ZONE)`
@@ -175,7 +180,9 @@ Use `"@"` as `OWNER` if you want to denote `ZONE` itself as the owner.
 * `zone-unset(ZONE, OWNER, [TYPE, [DATA]])`
 * `zone-purge(ZONE, [FILTERS={ocejktf}], [FLAGS="B"])`
   + `FILTERS`: orphan `(o)`, catalog `(c)`, expire `(e)`, journal `(j)`, kaspdb `(k)`, timers `(t)`, zonefile `(f)`
-* `zone-stats(ZONE, [SECTION:module], [ITEM:counter], [FLAGS="F":include 0 counters])`
+* `zone-stats(ZONE, [SECTION], [ITEM], [FLAGS="F"])`
+  + `SECTION` stores the module, `ITEM` stores the counter
+  + the `F` flag specifies to include 0 counters in server's response
 #### Configuration

{libknot-3.3.13.dev0 → libknot-3.3.14.dev0}/pyproject.toml RENAMED Viewed

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 [project]
 name = "libknot"
-version = "3.3.13dev"
+version = "3.3.14dev"
 description = "Python bindings for libknot"
 readme = "README.md"
 requires-python = ">=3.5"

{libknot-3.3.13.dev0 → libknot-3.3.14.dev0}/setup.py RENAMED Viewed

@@ -7,7 +7,7 @@ if p.exists():
 setuptools.setup(
     name='libknot',
-    version='3.3.13dev',
+    version='3.3.14dev',
     description='Python bindings for libknot',
     long_description=long_description,
     long_description_content_type="text/markdown",