edison-parser 0.2__tar.gz → 0.4__tar.gz

{edison_parser-0.2/src/edison_parser.egg-info → edison_parser-0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edison-parser
-Version: 0.2
+Version: 0.4
 Summary: An EDIFACT parser with a real syntax tree.
 Author-email: Alex Prengère <alex.prengere@gmail.com>
 License-Expression: MIT
@@ -36,16 +36,16 @@ Dynamic: license-file
 </div>
 
 Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
+message as a flat stream of segments, it models valid messages as a tree.
+You define the schema once, then parse, validate, or pretty-print
 messages against that structure.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
 - Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -109,16 +109,21 @@ REF+3'
 UNT+19+1'
 """
 
+# Create the parser and parse this EDIFACT message.
+# The `summary` attribute is populated by the callbacks.
 parser = PIZZAQParser()
 parser.parse(edi)
+parser.summary  # {"MARGARITA": 2, "PESTO": 1}
 
-assert parser.summary == {"MARGARITA": 2, "PESTO": 1}
-assert PIZZAQParser.validate(edi)
-print(PIZZAQParser.show(edi))
+# Validate and pretty-print the message.
+PIZZAQParser.validate(edi)  # True/False
+PIZZAQParser.show(edi)  # to print
 ```
 
+Here is the output of `PIZZAQParser.show(edi)`.
+
 <div align="center">
-    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="360" height="360" alt="Edison">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="364" alt="Edison">
     <p><strong>Tree-based structure.</strong></p>
 </div>
 
@@ -318,9 +323,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -345,6 +353,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.2 → edison_parser-0.4}/README.md

@@ -11,16 +11,16 @@
 </div>
 
 Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
+message as a flat stream of segments, it models valid messages as a tree.
+You define the schema once, then parse, validate, or pretty-print
 messages against that structure.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
 - Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -84,16 +84,21 @@ REF+3'
 UNT+19+1'
 """
 
+# Create the parser and parse this EDIFACT message.
+# The `summary` attribute is populated by the callbacks.
 parser = PIZZAQParser()
 parser.parse(edi)
+parser.summary  # {"MARGARITA": 2, "PESTO": 1}
 
-assert parser.summary == {"MARGARITA": 2, "PESTO": 1}
-assert PIZZAQParser.validate(edi)
-print(PIZZAQParser.show(edi))
+# Validate and pretty-print the message.
+PIZZAQParser.validate(edi)  # True/False
+PIZZAQParser.show(edi)  # to print
 ```
 
+Here is the output of `PIZZAQParser.show(edi)`.
+
 <div align="center">
-    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="360" height="360" alt="Edison">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="364" alt="Edison">
     <p><strong>Tree-based structure.</strong></p>
 </div>
 
@@ -293,9 +298,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -320,6 +328,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.2 → edison_parser-0.4/src/edison_parser.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: edison-parser
-Version: 0.2
+Version: 0.4
 Summary: An EDIFACT parser with a real syntax tree.
 Author-email: Alex Prengère <alex.prengere@gmail.com>
 License-Expression: MIT
@@ -36,16 +36,16 @@ Dynamic: license-file
 </div>
 
 Edison is a Python library for parsing EDIFACT messages. Instead of treating a
-message as a flat stream of segments, it models valid messages as a tree of
-transitions. You define the schema once, then parse, validate, or pretty-print
+message as a flat stream of segments, it models valid messages as a tree.
+You define the schema once, then parse, validate, or pretty-print
 messages against that structure.
 
 ## Highlights
 
 - Define EDIFACT syntax trees directly in Python.
+- Segments can define groups of child segments, which can be conditional, mandatory, or repeatable.
 - Attach parsing callbacks to the segments you care about.
 - Select schemas by message version.
-- Model conditional, mandatory, and repeatable segments.
 - Handle escaped EDIFACT separators and EBCDIC control characters.
 - Properly tokenize segments with specified lengths like `BLB`
 - Export transition graphs with `pydot`.
@@ -109,16 +109,21 @@ REF+3'
 UNT+19+1'
 """
 
+# Create the parser and parse this EDIFACT message.
+# The `summary` attribute is populated by the callbacks.
 parser = PIZZAQParser()
 parser.parse(edi)
+parser.summary  # {"MARGARITA": 2, "PESTO": 1}
 
-assert parser.summary == {"MARGARITA": 2, "PESTO": 1}
-assert PIZZAQParser.validate(edi)
-print(PIZZAQParser.show(edi))
+# Validate and pretty-print the message.
+PIZZAQParser.validate(edi)  # True/False
+PIZZAQParser.show(edi)  # to print
 ```
 
+Here is the output of `PIZZAQParser.show(edi)`.
+
 <div align="center">
-    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="360" height="360" alt="Edison">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/Image.png" width="364" alt="Edison">
     <p><strong>Tree-based structure.</strong></p>
 </div>
 
@@ -318,9 +323,12 @@ finishes.
 <details>
 <summary>Transition graphs</summary>
 
-`pydot` is installed with Edison. To write PNG files, make sure Graphviz is
-available on your system, then call `build_dot_object()` on a `BaseParser`
-subclass.
+Internally, Edison builds a directed graph of transitions between segments, when the parser class is created.  
+Each node is a specific segment, and each edge is a valid transition to the next segment.  
+With this, parsing is just a walk through the graph, and validation is checking if the path exists.
+
+You can visualize the transition graph with `build_dot_object()`, which returns a `pydot.Dot` object.  
+`pydot` is installed with Edison. To write PNG files, make sure Graphviz is available on your system.
 
 ```python
 from edison import BaseParser
@@ -345,6 +353,12 @@ dot = Parser.build_dot_object()
 dot.write_png("transitions.png")
 ```
 
+Here is the resulting graph for the above schema.
+
+<p align="center">
+    <img src="https://raw.githubusercontent.com/AmadeusITGroup/Edison/main/docs/transitions.png" alt="pydot">
+</p>
+
 You can pass the same version selector used by parsing, and hide upward links
 for a simpler tree-like graph:
 

{edison_parser-0.2 → edison_parser-0.4}/src/edison_parser.egg-info/scm_file_list.json

@@ -16,6 +16,7 @@
     "README.md",
     "docs/Image.png",
     "docs/edison.png",
+    "docs/transitions.png",
     "pyproject.toml",
     "src/edison/__init__.py",
     "src/edison/envelope.py",

{edison_parser-0.2 → edison_parser-0.4}/src/edison_parser.egg-info/scm_version.json

@@ -1,7 +1,7 @@
 {
-  "tag": "0.2",
+  "tag": "0.4",
   "distance": 0,
-  "node": "g82e7d515e1682ec92e09285fb19b461e5d92ceb8",
+  "node": "gd5d6d94b1b4dd48881eaa4ea42bee94e6e437a97",
   "dirty": false,
   "branch": "HEAD",
   "node_date": "2026-10-21"