@@ -15,21 +15,25 @@ Latest version on PyPi can be installed by command `pip3 install dfparser`
1515## Usage
1616#### Create simple message
1717 - 0x14000 protocol version
18+
1819 >>> import dfparser
1920 >>> dfparser.create_message({"param": "abc"}, data=b'bnary')
2021 b'#!\x00\x01@\x00pY_2\x00\x01\x00\x00\x00\x00\x00\x1a\x00\x00\x00\x00\x00\x00\x00\x05!#\r\n{\n "param": "abc"\n}\r\n\r\nbnary'
2122 - DF02 version
23+
2224 >>> import dfparser
2325 >>> dfparser.create_message({"param": "abc"}, b'binary', version=b'DF02')
2426 b'#~DF02JS\x00\x00\x00\x1a\x00\x00\x00\x06~#\r\n{\n "param": "abc"\n}\r\n\r\nbinary'
2527
2628#### Parse message
2729 - From file
30+
2831 >>> import dfparser
2932 >>> header, meta, data = envelope_parser.parse_from_file("df02.df")
3033 >>> # Or read only metadata
3134 >>> header, meta, _ = envelope_parser.parse_from_file("df02.df", nodata=True)
3235 - From bytes
36+
3337 >>> import dfparser
3438 >>> data = b'#~DF02JS\x00\x00\x00\x1a\x00\x00\x00\x06~#\r\n{\n "param": "abc"\n}\r\n\r\nbinary'
3539 >>> envelope_parser.parse_message(data)
@@ -38,6 +42,7 @@ Latest version on PyPi can be installed by command `pip3 install dfparser`
3842 b'binary')
3943
4044 - From stream
45+
4146 >>> import dfparser
4247 >>> # stream.df contains multiple messages sequentaly written
4348 >>> data = open("/home/chernov/stream.df", 'rb').read()
@@ -60,6 +65,7 @@ Latest version on PyPi can be installed by command `pip3 install dfparser`
6065
6166### Transparent compression
6267 To apply transparent compression to message meta should contains field ` "compression": "zlib" `
68+
6369 >>> import dfparser
6470 >>> data = b''.join(b'0' for _ in range(100))
6571 >>> compr = dfparser.create_message({"compression": "zlib"}, data)
@@ -70,6 +76,7 @@ Latest version on PyPi can be installed by command `pip3 install dfparser`
7076 True
7177
7278## Build
79+
7380 # Update protobuf formats use:
7481 #(Protobuf 3.2.0+)[https://github.com/google/protobuf/releases] should
7582 # be installed and be in $PATH
0 commit comments