nacos-sdk-rust-binding-py 0.1.1__cp37-none-win_amd64.whl → 0.1.2__cp37-none-win_amd64.whl

nacos_sdk_rust_binding_py-0.1.2.dist-info/METADATA

@@ -0,0 +1,249 @@
+Metadata-Version: 2.1
+Name: nacos-sdk-rust-binding-py
+Version: 0.1.2
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Dist: pdoc ; extra == 'docs'
+Requires-Dist: behave ; extra == 'test'
+Provides-Extra: docs
+Provides-Extra: test
+License-File: LICENSE
+Summary: nacos-sdk-rust binding for Python.
+Keywords: nacos,ffi,pyo3,binding,python
+Author: CheirshCai <785427346@qq.com>
+Author-email: CheirshCai <785427346@qq.com>
+License: Apache-2.0
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Documentation, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
+Project-URL: Homepage, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
+Project-URL: Repository, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
+
+# nacos-sdk-rust-binding-py
+nacos-sdk-rust binding for Python with PyO3.
+
+Tip: nacos-sdk-python 仓库暂未提供 2.x gRPC 交互模式，为了能升级它，故而通过 ffi 方式调用 nacos-sdk-rust
+
+## Installation
+
+```bash
+pip install nacos-sdk-rust-binding-py
+```
+
+- project package see https://pypi.org/project/nacos-sdk-rust-binding-py
+
+## Usage
+
+**使用样例请看仓库内的 examples 目录**
+
+- 客户端日志请在目录 `$HOME/logs/nacos/` 查看
+
+### Definition of ClientOptions
+
+```python
+class ClientOptions:
+    # Server Addr, e.g. address:port[,address:port],...]
+    #[pyo3(set, get)]
+    server_addr: String,
+    # Namespace/Tenant
+    #[pyo3(set, get)]
+    namespace: String,
+    # AppName
+    #[pyo3(set, get)]
+    app_name: Option<String>,
+    # Username for Auth
+    #[pyo3(set, get)]
+    username: Option<String>,
+    # Password for Auth
+    #[pyo3(set, get)]
+    password: Option<String>,
+
+    # Init
+    def __init__(self, server_addr, namespace, app_name, username, password):
+        self.server_addr = server_addr
+        self.server_addr = namespace
+        self.app_name = app_name
+        self.username = username
+        self.password = password
+
+```
+
+### Definition of Config
+
+```python
+class NacosConfigResponse:
+    # Namespace/Tenant
+    # [pyo3(get)]
+    namespace: String,
+    # DataId
+    # [pyo3(get)]
+    data_id: String,
+    # Group
+    # [pyo3(get)]
+    group: String,
+    # Content
+    # [pyo3(get)]
+    content: String,
+    # Content's Type; e.g. json,properties,xml,html,text,yaml
+    # [pyo3(get)]
+    content_type: String,
+    # Content's md5
+    # [pyo3(get)]
+    md5: String,
+
+
+class NacosConfigClient:
+    # Init. If it fails, pay attention to err
+    def __init__(self, client_options: ClientOptions):
+        # inner logic xxx
+        pass
+
+    # Get config's content. If it fails, pay attention to err
+    def get_config(self, data_id: String, group: String) -> String:
+        pass
+
+    # Get NacosConfigResponse. If it fails, pay attention to err
+    def get_config_resp(self, data_id: String, group: String) -> NacosConfigResponse:
+        pass
+
+    # Publish config. If it fails, pay attention to err
+    def publish_config(self, data_id: String, group: String, content: String) -> bool:
+        pass
+
+    # Remove config. If it fails, pay attention to err
+    def remove_config(self, data_id: String, group: String) -> bool:
+        pass
+
+    # Add NacosConfigChangeListener callback func, which listen the config change. If it fails, pay attention to err
+    def add_listener(self, data_id: String, group: String, listener: py_function):
+        pass
+
+
+```
+
+### Definition of Naming
+
+```python
+class NacosServiceInstance:
+    # Instance Id
+    #[pyo3(set, get)]
+    instance_id: Option<String>,
+    # Ip
+    #[pyo3(set, get)]
+    ip: String,
+    # Port
+    #[pyo3(set, get)]
+    port: i32,
+    # Weight, default 1.0
+    #[pyo3(set, get)]
+    weight: Option<f64>,
+    # Healthy or not, default true
+    #[pyo3(set, get)]
+    healthy: Option<bool>,
+    # Enabled ot not, default true
+    #[pyo3(set, get)]
+    enabled: Option<bool>,
+    # Ephemeral or not, default true
+    #[pyo3(set, get)]
+    ephemeral: Option<bool>,
+    # Cluster Name, default 'DEFAULT'
+    #[pyo3(set, get)]
+    cluster_name: Option<String>,
+    # Service Name
+    #[pyo3(set, get)]
+    service_name: Option<String>,
+    # Metadata, default '{}'
+    #[pyo3(set, get)]
+    metadata: Option<std::collections::HashMap<String, String>>,
+
+    # Init
+    def __init__(self, ip, port, weight, healthy, enabled, ephemeral, cluster_name, service_name, metadata):
+        # inner logic xxx
+        pass
+
+
+class NacosNamingClient:
+    # Init. If it fails, pay attention to err
+    def __init__(self, client_options: ClientOptions):
+        # inner logic xxx
+        pass
+
+    # Register instance. If it fails, pay attention to err
+    def register_instance(self, service_name: String, group: String, service_instance: NacosServiceInstance):
+        pass
+
+    # Deregister instance. If it fails, pay attention to err
+    def deregister_instance(self, service_name: String, group: String, service_instance: NacosServiceInstance):
+        pass
+
+    # Batch register instance, improve interaction efficiency. If it fails, pay attention to err
+    def batch_register_instance(self, service_name: String, group: String, service_instances: [NacosServiceInstance]):
+        pass
+
+    # Get all instances by service and group. default cluster=[], subscribe=true. If it fails, pay attention to err
+    def get_all_instances(self, service_name: String, group: String, clusters: Option<[String]>, subscribe: Option<bool>) -> [NacosServiceInstance]:
+        pass
+
+    # Select instances whether healthy or not. default cluster=[], subscribe=true, healthy=true. If it fails, pay attention to err
+    def select_instances(self, service_name: String, group: String, clusters: Option<[String]>, subscribe: Option<bool>, healthy: Option<bool>) -> [NacosServiceInstance]:
+        pass
+
+    # Select one healthy instance. default cluster=[], subscribe=true. If it fails, pay attention to err
+    def select_one_healthy_instance(self, service_name: String, group: String, clusters: Option<[String]>, subscribe: Option<bool>) -> NacosServiceInstance:
+        pass
+
+    # Add NacosNamingEventListener callback func, which listen the instance change. If it fails, pay attention to err
+    def subscribe(self, service_name: String, group: String, clusters: Option<[String]>, listener: py_function) -> NacosServiceInstance:
+        pass
+
+
+```
+
+## Development
+
+Setup virtualenv:
+
+```shell
+python -m venv venv
+```
+
+Activate venv:
+
+```shell
+source venv/bin/activate
+````
+
+Install `maturin`:
+
+```shell
+pip install maturin[patchelf]
+```
+
+Build bindings:
+
+```shell
+maturin develop
+```
+
+Run some tests:
+
+```shell
+maturin develop -E test
+behave tests
+```
+
+Build API docs:
+
+```shell
+maturin develop -E docs
+pdoc nacos-sdk-rust-binding-py
+```
+
+# License
+[Apache License Version 2.0](LICENSE)
+
+# Acknowledgement
+- binding for Python with [PyO3](https://github.com/PyO3/pyo3.git)
+- binding the [nacos-sdk-rust](https://github.com/nacos-group/nacos-sdk-rust.git)
+

nacos_sdk_rust_binding_py-0.1.2.dist-info/RECORD

@@ -0,0 +1,6 @@
+nacos_sdk_rust_binding_py-0.1.2.dist-info/METADATA,sha256=tW5yoyDyzYZ2gyHMGR1XLY7sHmPHaFQTmkZ1rK8cUfM,7307
+nacos_sdk_rust_binding_py-0.1.2.dist-info/WHEEL,sha256=kPG75xB_PYaq5pDDR7ltMB9iWIiOnI8wAwZJI1CfQrw,94
+nacos_sdk_rust_binding_py-0.1.2.dist-info/license_files/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+nacos_sdk_rust_binding_py/__init__.py,sha256=KQBZgI2Tvj-KFIC7ObI-xwCQrmcYncTxJgANsMNd5UQ,183
+nacos_sdk_rust_binding_py/nacos_sdk_rust_binding_py.pyd,sha256=gfsda2nR3bcWHvcT-3N-Zu4rG2beU7LS1lJ_XqgPOD8,8280064
+nacos_sdk_rust_binding_py-0.1.2.dist-info/RECORD,,

nacos_sdk_rust_binding_py-0.1.1.dist-info/METADATA

@@ -1,84 +0,0 @@
-Metadata-Version: 2.1
-Name: nacos-sdk-rust-binding-py
-Version: 0.1.1
-Classifier: Programming Language :: Rust
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Dist: pdoc ; extra == 'docs'
-Requires-Dist: behave ; extra == 'test'
-Provides-Extra: docs
-Provides-Extra: test
-License-File: LICENSE
-Summary: nacos-sdk-rust binding for Python.
-Keywords: nacos,ffi,pyo3,binding,python
-Author: CheirshCai <785427346@qq.com>
-Author-email: CheirshCai <785427346@qq.com>
-License: Apache-2.0
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
-Project-URL: Documentation, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
-Project-URL: Homepage, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
-Project-URL: Repository, https://github.com/opc-source/nacos-sdk-rust-binding-py.git
-
-# nacos-sdk-rust-binding-py
-nacos-sdk-rust binding for Python with PyO3.
-
-Tip: nacos-sdk-python 仓库暂未提供 2.x gRPC 交互模式，为了能升级它，故而通过 ffi 方式调用 nacos-sdk-rust
-
-## Installation
-
-```bash
-pip install nacos-sdk-rust-binding-py
-```
-
-# Usage
-- see https://pypi.org/project/nacos-sdk-rust-binding-py
-- TODO
-
-## Development
-
-Setup virtualenv:
-
-```shell
-python -m venv venv
-```
-
-Activate venv:
-
-```shell
-source venv/bin/activate
-````
-
-Install `maturin`:
-
-```shell
-pip install maturin[patchelf]
-```
-
-Build bindings:
-
-```shell
-maturin develop
-```
-
-Run some tests:
-
-```shell
-maturin develop -E test
-behave tests
-```
-
-Build API docs:
-
-```shell
-maturin develop -E docs
-pdoc nacos-sdk-rust-binding-py
-```
-
-# License
-[Apache License Version 2.0](LICENSE)
-
-# Acknowledgement
-- binding for Python with [PyO3](https://github.com/PyO3/pyo3.git)
-- binding the [nacos-sdk-rust](https://github.com/nacos-group/nacos-sdk-rust.git)
-

nacos_sdk_rust_binding_py-0.1.1.dist-info/RECORD

@@ -1,6 +0,0 @@
-nacos_sdk_rust_binding_py-0.1.1.dist-info/METADATA,sha256=5O5JEQg8K_MDjYlt035wwNCYxFlKJn_yK9xpiaXCCOM,1942
-nacos_sdk_rust_binding_py-0.1.1.dist-info/WHEEL,sha256=kPG75xB_PYaq5pDDR7ltMB9iWIiOnI8wAwZJI1CfQrw,94
-nacos_sdk_rust_binding_py-0.1.1.dist-info/license_files/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
-nacos_sdk_rust_binding_py/__init__.py,sha256=KQBZgI2Tvj-KFIC7ObI-xwCQrmcYncTxJgANsMNd5UQ,183
-nacos_sdk_rust_binding_py/nacos_sdk_rust_binding_py.pyd,sha256=jUlDf_x41wLs-YJN7_DjxYETpja04LVXA_BwvalYDdk,8272384
-nacos_sdk_rust_binding_py-0.1.1.dist-info/RECORD,,