neterse 0.1.0__tar.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.
neterse-0.1.0/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 Pedro Damasceno
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
neterse-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,180 @@
1
+ Metadata-Version: 2.4
2
+ Name: neterse
3
+ Version: 0.1.0
4
+ Summary: neterse — minimum-token renderings of network CLI output for LLM agents. The `| brief` the vendor never shipped.
5
+ Author: Pedro Damasceno
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/pcDamasceno/neterse
8
+ Project-URL: Issues, https://github.com/pcDamasceno/neterse/issues
9
+ Keywords: network-automation,llm,tokens,cli,toon,cisco,nxos,ios,agents,prompt-engineering
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: System Administrators
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: License :: OSI Approved :: Apache Software License
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: System :: Networking
21
+ Requires-Python: >=3.9
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Provides-Extra: test
25
+ Requires-Dist: pytest; extra == "test"
26
+ Dynamic: license-file
27
+
28
+ # neterse
29
+
30
+ *Minimum-token renderings of network CLI output for LLM agents — the
31
+ `| brief` the vendor never shipped.*
32
+
33
+ LLM-driven network agents burn most of their context window on the noise in
34
+ `show`-command output: separator dashes, static legends, wrapped headers,
35
+ all-zero counter tables, and keys repeated on every row. **neterse** rewrites
36
+ that output into the smallest representation that preserves the semantics,
37
+ before it enters model context — so agents spend tokens on reasoning, not
38
+ formatting. Savings of 40–60% are typical on tabular output; on huge
39
+ mostly-zero tables, compression is the difference between a truncated tool
40
+ result and a complete one.
41
+
42
+ ```python
43
+ from neterse import render, optimize
44
+
45
+ # Full API — every candidate that shrinks the output; policy is yours:
46
+ candidates = render(raw, command="show interface status", platform="cisco_nxos")
47
+ best = min(candidates, key=lambda c: len(c.text), default=None)
48
+
49
+ # Convenience wrapper — smallest candidate's text, or raw unchanged:
50
+ compact = optimize("show interface status", raw)
51
+
52
+ # Parsed tier — rows Genie/ntc-templates already produced, re-encoded
53
+ # header-once (beats json.dumps(rows) by ~45-50% on multi-row output):
54
+ candidates = render(raw, command="show ip int brief", parsed=rows)
55
+
56
+ # Opt-in declared-lossy projection; the rendering itself says what was
57
+ # withheld: "[omitted: name, vlan, ... — re-query profile=full]"
58
+ candidates = render(raw, command="show interface status", profile="updown")
59
+ ```
60
+
61
+ ```
62
+ Port Name Status Vlan Duplex Speed Type
63
+ --------------------------------------------------------------------------------
64
+ Eth1/11 RSRFF206 Twe1/0/3 connected routed full 10G 10Gbase-SR
65
+ Eth1/45 RFRA3213-Eth1/48 connected routed full 10G 10Gbase-LR
66
+ │
67
+ ▼ neterse
68
+ port,name,status,vlan,duplex,speed,type
69
+ Eth1/11,RSRFF206 Twe1/0/3,connected,routed,full,10G,10Gbase-SR
70
+ Eth1/45,RFRA3213-Eth1/48,connected,routed,full,10G,10Gbase-LR
71
+ ```
72
+
73
+ ## Install
74
+
75
+ ```bash
76
+ pip install neterse # import name: neterse
77
+ ```
78
+
79
+ > Named **neterse** ("network terse") because the natural name `terse` is
80
+ > occupied on PyPI by an unrelated package abandoned in 2019. Distribution,
81
+ > import, and CLI all share the one name.
82
+
83
+ ## Design in one paragraph
84
+
85
+ Two tiers, one contract. The **raw-text tier** compresses CLI output
86
+ directly — declarative specs drive generic strategies (fixed-width
87
+ table → CSV, line-regex table → CSV, key-value scan), with plain-Python
88
+ compressors as the escape hatch for genuinely stateful formats. The
89
+ **parsed tier** re-encodes rows that Genie / ntc-templates / TTP / NAPALM
90
+ already parsed into compact header-once form (`render(..., parsed=rows)`
91
+ → CSV and TOON-style candidates that undercut `json.dumps(rows)` by
92
+ ~45–50%). Opt-in **profiles** (`profile="updown"`) narrow output to a
93
+ declared projection and say so inline
94
+ (`[omitted: … — re-query profile=full]`). Both tiers emit `Candidate`s;
95
+ the library **never picks a winner** — smallest-wins, ledgers, metrics,
96
+ and caching belong to the consumer. Full architecture:
97
+ [docs/DESIGN.md](docs/DESIGN.md).
98
+
99
+ ## Invariants
100
+
101
+ 1. **Fail-open, always.** A compressor that raises, returns a non-string,
102
+ returns empty, or fails to shrink produces no candidate. Raw data is
103
+ never lost and never enlarged.
104
+ 2. **Zero runtime dependencies.** Standard library only — enforced in CI.
105
+ Tokenizers are a CI concern; `Candidate.est_tokens()` is a chars/4
106
+ estimate by design.
107
+ 3. **Candidates, not policy.** Consumers decide what to send to the model.
108
+ 4. **Preserve semantically relevant data; declare every drop.** Noise
109
+ (separators, legends, all-zero rows — kept visible via explicit
110
+ `(all zero)` markers) is dropped freely; anything else a rendering omits
111
+ must be declared machine-readably on the candidate
112
+ (`Candidate.dropped_fields`).
113
+ 5. **Byte-parity discipline.** The original implementation is
114
+ frozen in-tree (`tests/legacy_snapshot.py`); the parity suite replays a
115
+ cross-matrix corpus and pins today's outputs byte-for-byte. Engine
116
+ refactors may change *how*, never *what*. Intentional output changes are
117
+ recorded baseline decisions.
118
+
119
+ ## Provenance & prior art
120
+
121
+ neterse grew out of a TOON optimizer ("Token-Optimized Output for
122
+ Networks", inspired by [NetClaw]'s TOON serialization work) built for a
123
+ network agent, and is now a standalone, community-extensible library. It
124
+ complements — not competes with — the parsing ecosystems: [ntc-templates],
125
+ [Genie/pyATS] and [TTP] turn CLI text into structure; neterse makes
126
+ structure (and unparseable raw text) *cheap to show to a model*. The
127
+ tabular encoding aligns with
128
+ [TOON — Token-Oriented Object Notation]; emitting spec-compliant TOON for
129
+ uniform tables is on the roadmap.
130
+
131
+ [NetClaw]: https://github.com/automateyournetwork/netclaw
132
+ [ntc-templates]: https://github.com/networktocode/ntc-templates
133
+ [Genie/pyATS]: https://developer.cisco.com/docs/pyats/
134
+ [TTP]: https://github.com/dmulyalin/ttp
135
+ [TOON — Token-Oriented Object Notation]: https://github.com/toon-format/toon
136
+
137
+ ## Roadmap
138
+
139
+ | Phase | Contents | Status |
140
+ |---|---|---|
141
+ | 0 | API frozen (`render`/`Candidate`/`optimize`/`register`); 15 compressor families extracted verbatim; byte-parity baseline | ✅ |
142
+ | 1 | Spec engine (generic strategies over declarative specs), platform-keyed dispatch, declared-lossiness manifests | ✅ |
143
+ | 2 | Parsed tier: field projection + compact encoders (CSV/TOON) over pre-parsed rows; opt-in profiles with inline omission markers; `kv_extract` strategy | ✅ |
144
+ | 3 | `neterse audit` coverage tool, fixture-per-file contribution flow, CI token-savings regression (pinned tokenizer), multi-vendor expansion (Arista EOS, Junos, Aruba AOS-CX, MikroTik), PyPI release machinery | ✅ |
145
+ | 4 | Consumers swap vendored copies for the pip dependency; propose a TOON profile for network data upstream | ▢ |
146
+
147
+ ## Coverage
148
+
149
+ Command families ship for **Cisco IOS/IOS-XE/NX-OS** (15 legacy families:
150
+ routes, interfaces, BGP/OSPF/EIGRP neighbors, CDP/LLDP, VLANs, ACLs,
151
+ counters, port-channels, version, running-config), **Arista EOS**
152
+ (interfaces status, ip arp, vlan), **Juniper Junos** (interfaces terse,
153
+ ospf neighbor), **Aruba AOS-CX** (interface brief, vlan) and **MikroTik
154
+ RouterOS** (`/ip address print`, `/interface print`) — and the parsed
155
+ tier covers anything your parser already handles, on any platform.
156
+
157
+ Measure coverage over your own agent's traffic with the bundled CLI:
158
+
159
+ ```bash
160
+ neterse audit run.jsonl --show 3 # {"command":..., "platform":..., "raw":...} per line
161
+ neterse audit tests/fixtures # or point it at a fixture tree
162
+ ```
163
+
164
+ It reports per-family reduction, what reached the model uncompressed
165
+ (`NO COMPRESSOR` / `false-match` / `platform-skip`), and each winning
166
+ entry's declared drops — the gaps it prints are, in order, the next
167
+ specs worth contributing.
168
+
169
+ ## Contributing
170
+
171
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Short version: most new command
172
+ families are **a spec dict plus two fixture files**
173
+ (`tests/fixtures/<platform>/<family>/{commands.txt,raw.txt}`) — no parser
174
+ code, and the suite auto-covers anything dropped there. The escape hatch
175
+ for stateful formats is a plain function under the same fail-open
176
+ contract.
177
+
178
+ ## License
179
+
180
+ Apache-2.0 — see [LICENSE](LICENSE).
@@ -0,0 +1,153 @@
1
+ # neterse
2
+
3
+ *Minimum-token renderings of network CLI output for LLM agents — the
4
+ `| brief` the vendor never shipped.*
5
+
6
+ LLM-driven network agents burn most of their context window on the noise in
7
+ `show`-command output: separator dashes, static legends, wrapped headers,
8
+ all-zero counter tables, and keys repeated on every row. **neterse** rewrites
9
+ that output into the smallest representation that preserves the semantics,
10
+ before it enters model context — so agents spend tokens on reasoning, not
11
+ formatting. Savings of 40–60% are typical on tabular output; on huge
12
+ mostly-zero tables, compression is the difference between a truncated tool
13
+ result and a complete one.
14
+
15
+ ```python
16
+ from neterse import render, optimize
17
+
18
+ # Full API — every candidate that shrinks the output; policy is yours:
19
+ candidates = render(raw, command="show interface status", platform="cisco_nxos")
20
+ best = min(candidates, key=lambda c: len(c.text), default=None)
21
+
22
+ # Convenience wrapper — smallest candidate's text, or raw unchanged:
23
+ compact = optimize("show interface status", raw)
24
+
25
+ # Parsed tier — rows Genie/ntc-templates already produced, re-encoded
26
+ # header-once (beats json.dumps(rows) by ~45-50% on multi-row output):
27
+ candidates = render(raw, command="show ip int brief", parsed=rows)
28
+
29
+ # Opt-in declared-lossy projection; the rendering itself says what was
30
+ # withheld: "[omitted: name, vlan, ... — re-query profile=full]"
31
+ candidates = render(raw, command="show interface status", profile="updown")
32
+ ```
33
+
34
+ ```
35
+ Port Name Status Vlan Duplex Speed Type
36
+ --------------------------------------------------------------------------------
37
+ Eth1/11 RSRFF206 Twe1/0/3 connected routed full 10G 10Gbase-SR
38
+ Eth1/45 RFRA3213-Eth1/48 connected routed full 10G 10Gbase-LR
39
+ │
40
+ ▼ neterse
41
+ port,name,status,vlan,duplex,speed,type
42
+ Eth1/11,RSRFF206 Twe1/0/3,connected,routed,full,10G,10Gbase-SR
43
+ Eth1/45,RFRA3213-Eth1/48,connected,routed,full,10G,10Gbase-LR
44
+ ```
45
+
46
+ ## Install
47
+
48
+ ```bash
49
+ pip install neterse # import name: neterse
50
+ ```
51
+
52
+ > Named **neterse** ("network terse") because the natural name `terse` is
53
+ > occupied on PyPI by an unrelated package abandoned in 2019. Distribution,
54
+ > import, and CLI all share the one name.
55
+
56
+ ## Design in one paragraph
57
+
58
+ Two tiers, one contract. The **raw-text tier** compresses CLI output
59
+ directly — declarative specs drive generic strategies (fixed-width
60
+ table → CSV, line-regex table → CSV, key-value scan), with plain-Python
61
+ compressors as the escape hatch for genuinely stateful formats. The
62
+ **parsed tier** re-encodes rows that Genie / ntc-templates / TTP / NAPALM
63
+ already parsed into compact header-once form (`render(..., parsed=rows)`
64
+ → CSV and TOON-style candidates that undercut `json.dumps(rows)` by
65
+ ~45–50%). Opt-in **profiles** (`profile="updown"`) narrow output to a
66
+ declared projection and say so inline
67
+ (`[omitted: … — re-query profile=full]`). Both tiers emit `Candidate`s;
68
+ the library **never picks a winner** — smallest-wins, ledgers, metrics,
69
+ and caching belong to the consumer. Full architecture:
70
+ [docs/DESIGN.md](docs/DESIGN.md).
71
+
72
+ ## Invariants
73
+
74
+ 1. **Fail-open, always.** A compressor that raises, returns a non-string,
75
+ returns empty, or fails to shrink produces no candidate. Raw data is
76
+ never lost and never enlarged.
77
+ 2. **Zero runtime dependencies.** Standard library only — enforced in CI.
78
+ Tokenizers are a CI concern; `Candidate.est_tokens()` is a chars/4
79
+ estimate by design.
80
+ 3. **Candidates, not policy.** Consumers decide what to send to the model.
81
+ 4. **Preserve semantically relevant data; declare every drop.** Noise
82
+ (separators, legends, all-zero rows — kept visible via explicit
83
+ `(all zero)` markers) is dropped freely; anything else a rendering omits
84
+ must be declared machine-readably on the candidate
85
+ (`Candidate.dropped_fields`).
86
+ 5. **Byte-parity discipline.** The original implementation is
87
+ frozen in-tree (`tests/legacy_snapshot.py`); the parity suite replays a
88
+ cross-matrix corpus and pins today's outputs byte-for-byte. Engine
89
+ refactors may change *how*, never *what*. Intentional output changes are
90
+ recorded baseline decisions.
91
+
92
+ ## Provenance & prior art
93
+
94
+ neterse grew out of a TOON optimizer ("Token-Optimized Output for
95
+ Networks", inspired by [NetClaw]'s TOON serialization work) built for a
96
+ network agent, and is now a standalone, community-extensible library. It
97
+ complements — not competes with — the parsing ecosystems: [ntc-templates],
98
+ [Genie/pyATS] and [TTP] turn CLI text into structure; neterse makes
99
+ structure (and unparseable raw text) *cheap to show to a model*. The
100
+ tabular encoding aligns with
101
+ [TOON — Token-Oriented Object Notation]; emitting spec-compliant TOON for
102
+ uniform tables is on the roadmap.
103
+
104
+ [NetClaw]: https://github.com/automateyournetwork/netclaw
105
+ [ntc-templates]: https://github.com/networktocode/ntc-templates
106
+ [Genie/pyATS]: https://developer.cisco.com/docs/pyats/
107
+ [TTP]: https://github.com/dmulyalin/ttp
108
+ [TOON — Token-Oriented Object Notation]: https://github.com/toon-format/toon
109
+
110
+ ## Roadmap
111
+
112
+ | Phase | Contents | Status |
113
+ |---|---|---|
114
+ | 0 | API frozen (`render`/`Candidate`/`optimize`/`register`); 15 compressor families extracted verbatim; byte-parity baseline | ✅ |
115
+ | 1 | Spec engine (generic strategies over declarative specs), platform-keyed dispatch, declared-lossiness manifests | ✅ |
116
+ | 2 | Parsed tier: field projection + compact encoders (CSV/TOON) over pre-parsed rows; opt-in profiles with inline omission markers; `kv_extract` strategy | ✅ |
117
+ | 3 | `neterse audit` coverage tool, fixture-per-file contribution flow, CI token-savings regression (pinned tokenizer), multi-vendor expansion (Arista EOS, Junos, Aruba AOS-CX, MikroTik), PyPI release machinery | ✅ |
118
+ | 4 | Consumers swap vendored copies for the pip dependency; propose a TOON profile for network data upstream | ▢ |
119
+
120
+ ## Coverage
121
+
122
+ Command families ship for **Cisco IOS/IOS-XE/NX-OS** (15 legacy families:
123
+ routes, interfaces, BGP/OSPF/EIGRP neighbors, CDP/LLDP, VLANs, ACLs,
124
+ counters, port-channels, version, running-config), **Arista EOS**
125
+ (interfaces status, ip arp, vlan), **Juniper Junos** (interfaces terse,
126
+ ospf neighbor), **Aruba AOS-CX** (interface brief, vlan) and **MikroTik
127
+ RouterOS** (`/ip address print`, `/interface print`) — and the parsed
128
+ tier covers anything your parser already handles, on any platform.
129
+
130
+ Measure coverage over your own agent's traffic with the bundled CLI:
131
+
132
+ ```bash
133
+ neterse audit run.jsonl --show 3 # {"command":..., "platform":..., "raw":...} per line
134
+ neterse audit tests/fixtures # or point it at a fixture tree
135
+ ```
136
+
137
+ It reports per-family reduction, what reached the model uncompressed
138
+ (`NO COMPRESSOR` / `false-match` / `platform-skip`), and each winning
139
+ entry's declared drops — the gaps it prints are, in order, the next
140
+ specs worth contributing.
141
+
142
+ ## Contributing
143
+
144
+ See [CONTRIBUTING.md](CONTRIBUTING.md). Short version: most new command
145
+ families are **a spec dict plus two fixture files**
146
+ (`tests/fixtures/<platform>/<family>/{commands.txt,raw.txt}`) — no parser
147
+ code, and the suite auto-covers anything dropped there. The escape hatch
148
+ for stateful formats is a plain function under the same fail-open
149
+ contract.
150
+
151
+ ## License
152
+
153
+ Apache-2.0 — see [LICENSE](LICENSE).