migrate submodule back

Author: digizeph

Cargo.toml

@@ -4,7 +4,7 @@ description = "BGPKIT Parser Python Binding"
 keywords = ["bgp", "mrt", "parser"]
 repository = "https://github.com/bgpkit/bgpkit-parser-py"
 documentation = "https://docs.rs/bgpkit-parser-py"
-version = "0.3.0"
+version = "0.4.3"
 authors = ["Mingwei Zhang <[email protected]>"]
 edition = "2021"
 license = "MIT"
@@ -15,10 +15,9 @@ name = "pybgpkit_parser"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-bgpkit-parser = "0.8.1"
-pyo3 = { version = "0.17.3", features = ["extension-module"] }
+bgpkit-parser = "0.9.4"
+pyo3 = { version = "0.18.2", features = ["extension-module"] }
 dict_derive = "0.4.0"
-openssl = { version = "0.10", features = ["vendored"] }
 
 [build-dependencies]
-pyo3-build-config = "0.17.3"
+pyo3-build-config = "0.18.2"

Dockerfile

@@ -1,7 +1,26 @@
-FROM messense/manylinux2014-cross:x86_64
+FROM ubuntu:bionic
 
-RUN apt update && apt install cargo libssl-dev pkg-config -y
-RUN python3 -m pip install maturin
+RUN apt update && DEBIAN_FRONTEND=noninteractive TZ=Etc/UTC apt install -y curl libssl-dev pkg-config build-essential software-properties-common tzdata git vim
+
+# install different versions of Python
+RUN add-apt-repository ppa:deadsnakes/ppa -y && apt update
+RUN apt install -y \
+python3.7 python3.7-distutils \
+python3.8 python3.8-distutils \
+python3.9 python3.9-distutils \
+python3.10 python3.10-distutils \
+python3.11 python3.11-distutils
+
+RUN \
+curl -sS https://bootstrap.pypa.io/get-pip.py | python3.7 && \
+curl -sS https://bootstrap.pypa.io/get-pip.py | python3.8 && \
+curl -sS https://bootstrap.pypa.io/get-pip.py | python3.9 && \
+curl -sS https://bootstrap.pypa.io/get-pip.py | python3.10 && \
+curl -sS https://bootstrap.pypa.io/get-pip.py | python3.11 
+
+# install maturin
+RUN python3.11 -m pip install maturin patchelf
+# install Rust
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
 
 WORKDIR /io
-ENTRYPOINT ["/usr/local/bin/maturin"]

README.md

@@ -5,11 +5,32 @@ Python binding for bgpkit-parser
 ## Example
 
 ```python
+from pybgpkit_parser import Parser
+import json
+
+parser = Parser(
+    url="https://spaces.bgpkit.org/parser/update-example",
+    filters={"peer_ips": "185.1.8.65, 2001:7f8:73:0:3:fa4:0:1"},
+)
+
+for elem in parser:
+    print(elem["origin_asns"])
+    print(json.dumps(elem, indent=4))
+    break
+```
 
+You can also add `cache_dir` to Parser to cache the downloaded files to a specified directory.
+
+Here is an example:
+```python
 from pybgpkit_parser import Parser
 import json
 
-parser = Parser(url="https://spaces.bgpkit.org/parser/update-example", filters={"peer_ips": "185.1.8.65, 2001:7f8:73:0:3:fa4:0:1"})
+parser = Parser(
+    url="https://spaces.bgpkit.org/parser/update-example",
+    filters={"peer_ips": "185.1.8.65, 2001:7f8:73:0:3:fa4:0:1"},
+    cache_dir="./"
+)
 
 for elem in parser:
     print(elem["origin_asns"])
@@ -53,8 +74,47 @@ maturin publish --interpreter python3.10 --skip-existing
 maturin publish --interpreter python3.11 --skip-existing
 ```
 
+#### Using docker
+
+```
+docker build -t bgpkit-builder:latest .
+docker run --rm -it bgpkit-builder:latest bash
+
+####
+# TODO: copy the content of .pypirc to the root folder
+####
+git clone https://github.com/bgpkit/bgpkit-parser.git
+cd bgpkit-parser/bgpkit-parser-py
+
+maturin publish --interpreter python3.7 --skip-existing
+maturin publish --interpreter python3.8 --skip-existing
+maturin publish --interpreter python3.9 --skip-existing
+maturin publish --interpreter python3.10 --skip-existing
+maturin publish --interpreter python3.11 --skip-existing
+
+```
+
 ### Publish for MacOS
 
+#### M1-based
+
+**Minimum support version for M1 Macs is Python 3.8**
+
+Install multiple Python interpreters:
 ```bash
-maturin publish --skip-existing
+brew install [email protected]
+brew install [email protected]
+brew install [email protected]
+brew install [email protected]
 ```
+
+```bash
+maturin publish --interpreter python3.8 --skip-existing
+maturin publish --interpreter python3.9 --skip-existing
+maturin publish --interpreter python3.10 --skip-existing
+maturin publish --interpreter python3.11 --skip-existing
+```
+
+#### Intel-based
+
+- [ ] add support for packaging for Intel-based Macs 

build.rs

@@ -1,3 +1,3 @@
 fn main() {
     pyo3_build_config::add_extension_module_link_args();
-}
+}

src/lib.rs

@@ -1,41 +1,43 @@
-use std::collections::HashMap;
+use bgpkit_parser::models::*;
 use bgpkit_parser::*;
+use dict_derive::{FromPyObject, IntoPyObject};
 use pyo3::exceptions::PyValueError;
 use pyo3::prelude::*;
-use dict_derive::{FromPyObject, IntoPyObject};
+use std::collections::HashMap;
+use std::io::Read;
 
 #[pymodule]
 fn pybgpkit_parser(_py: Python, m: &PyModule) -> PyResult<()> {
-
     fn convert_elem(elem: BgpElem) -> Elem {
         Elem {
             timestamp: elem.timestamp,
             elem_type: match elem.elem_type {
-                ElemType::ANNOUNCE => {"A".to_string()}
-                ElemType::WITHDRAW => {"W".to_string()}
-            }
-            ,
+                ElemType::ANNOUNCE => "A".to_string(),
+                ElemType::WITHDRAW => "W".to_string(),
+            },
             peer_ip: elem.peer_ip.to_string(),
             peer_asn: elem.peer_asn.asn,
             prefix: elem.prefix.to_string(),
             next_hop: elem.next_hop.map(|v| v.to_string()),
             as_path: elem.as_path.map(|v| v.to_string()),
-            origin_asns: elem.origin_asns.map(|v| v.into_iter().map(|x|x.asn).collect()),
+            origin_asns: elem
+                .origin_asns
+                .map(|v| v.into_iter().map(|x| x.asn).collect()),
             origin: elem.origin.map(|v| v.to_string()),
             local_pref: elem.local_pref,
             med: elem.med,
-            communities: elem.communities.map(|v| v.into_iter().map(|x|x.to_string()).collect()),
+            communities: elem
+                .communities
+                .map(|v| v.into_iter().map(|x| x.to_string()).collect()),
             atomic: match elem.atomic {
-                None => {
-                    None
-                }
-                Some(v) => {match v {
-                    AtomicAggregate::NAG => {Some("NAG".to_string())}
-                    AtomicAggregate::AG => {Some("AG".to_string())}
-                }}
+                None => None,
+                Some(v) => match v {
+                    AtomicAggregate::NAG => Some("NAG".to_string()),
+                    AtomicAggregate::AG => Some("AG".to_string()),
+                },
             },
             aggr_asn: elem.aggr_asn.map(|v| v.asn),
-            aggr_ip: elem.aggr_ip.map(|v| v.to_string())
+            aggr_ip: elem.aggr_ip.map(|v| v.to_string()),
         }
     }
 
@@ -55,44 +57,47 @@ fn pybgpkit_parser(_py: Python, m: &PyModule) -> PyResult<()> {
         pub communities: Option<Vec<String>>,
         pub atomic: Option<String>,
         pub aggr_asn: Option<u32>,
-        pub aggr_ip: Option<String>
+        pub aggr_ip: Option<String>,
     }
 
     #[pyclass]
     #[pyo3(text_signature = "(url, filters, /)")]
     struct Parser {
-        elem_iter: ElemIterator,
+        elem_iter: ElemIterator<Box<dyn Send + Read>>,
     }
 
     #[pymethods]
     impl Parser {
         #[new]
-        fn new(url: String, filters: Option<HashMap<String, String>>) -> PyResult<Self> {
-            let mut parser = BgpkitParser::new(url.as_str()).unwrap();
+        fn new(
+            url: String,
+            filters: Option<HashMap<String, String>>,
+            cache_dir: Option<String>,
+        ) -> PyResult<Self> {
+            let mut parser = match cache_dir {
+                None => BgpkitParser::new(url.as_str()).unwrap(),
+                Some(dir) => BgpkitParser::new_cached(url.as_str(), dir.as_str()).unwrap(),
+            };
 
             if let Some(filters) = filters {
-                for (k,v) in filters {
-                   parser = match parser.add_filter(k.as_str(), v.as_str()) {
-                       Ok(p) => {p}
-                       Err(e) => {
-                           return Err(PyValueError::new_err(e.to_string()))
-                       }
-                   }
+                for (k, v) in filters {
+                    parser = match parser.add_filter(k.as_str(), v.as_str()) {
+                        Ok(p) => p,
+                        Err(e) => return Err(PyValueError::new_err(e.to_string())),
+                    }
                 }
             }
             let elem_iter = parser.into_iter();
-            Ok(Parser{elem_iter})
+            Ok(Parser { elem_iter })
         }
 
         fn parse_all(&mut self) -> PyResult<Vec<Elem>> {
             let mut elems = vec![];
 
             loop {
                 match self.elem_iter.next() {
-                    None => {break}
-                    Some(e) => {
-                        elems.push(convert_elem(e))
-                    }
+                    None => break,
+                    Some(e) => elems.push(convert_elem(e)),
                 }
             }
             Ok(elems)
@@ -114,4 +119,4 @@ fn pybgpkit_parser(_py: Python, m: &PyModule) -> PyResult<()> {
 
     m.add_class::<Parser>()?;
     Ok(())
-}
+}

test.py

@@ -1,7 +1,11 @@
 from pybgpkit_parser import Parser
 import json
 
-parser = Parser(url="https://spaces.bgpkit.org/parser/update-example", filters={"peer_ips": "185.1.8.65, 2001:7f8:73:0:3:fa4:0:1"})
+parser = Parser(
+    url="https://spaces.bgpkit.org/parser/update-example",
+    filters={"peer_ips": "185.1.8.65, 2001:7f8:73:0:3:fa4:0:1"},
+    cache_dir="./cache"
+)
 
 for elem in parser:
     print(elem["origin_asns"])