Skip to content

Commit

Permalink
update parser documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
digizeph committed Mar 30, 2023
1 parent 9846540 commit 080375b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ elems = parser.parse_all()
assert len(elems) == 4227
```

The `Parser` constructor takes two parameters:
The `Parser` constructor takes the following parameters:
- `url`: the URL or local file path toward an MRT file
- `fitlers`: a dictionary of filters, available filters are:
- `fitlers`: optional a dictionary of filters, available filters are:
- `origin_asn`: origin AS number
- `prefix`: exact match prefix
- `prefix_super`: exact prefix and its super prefixes
Expand All @@ -33,6 +33,7 @@ The `Parser` constructor takes two parameters:
- `ts_start`: start unix timestamp
- `ts_end`: end unix timestamp
- `as_path`: regular expression for AS path string
- `cache_dir`: optional string for specifying a download cache directory


Each returning item has the following field:
Expand Down

0 comments on commit 080375b

Please sign in to comment.