docs: update README.md

README.md

@@ -1,8 +1,10 @@
 # namekoplus
 
+[![Upload Python Package](https://github.com/Bryanthelol/namekoplus/actions/workflows/python-publish.yml/badge.svg?event=release)](https://github.com/Bryanthelol/namekoplus/actions/workflows/python-publish.yml)
+
 A lightweight Python distributed microservice solution
 
-## Command Line Tool Usage
+## CLI Usage
 
 ### Checkout Command
 
@@ -27,5 +29,5 @@ namekoplus init --directory <dir_name> --type <template_type>
 
 See Documents: 
 
-- [中文](https://doc.bearcatlog.com/)
+- [English](https://legendary-sopapillas-e2626d.netlify.app/)
-- [English](https://legendary-sopapillas-e2626d.netlify.app/)
+- [中文](https://doc.bearcatlog.com/)

namekoplus/command.py

@@ -1,4 +1,3 @@
-import importlib
 import inspect
 import os
 import shutil
@@ -10,6 +9,10 @@ import shortuuid
 from python_on_whales import DockerException, ClientNotFoundError, DockerClient, docker
 from mako.template import Template
 
+INIT_TYPE_CHOICES = ['all', 'rpc', 'event', 'http', 'timer', 'demo']
+MIDDLEWARE_CHOICES = ['rabbitmq', 'metrics']
+TEST_TYPE_CHOICES = ['unit']
+
 
 def check_docker():
     """
@@ -132,7 +135,7 @@ def start_grafana():
         grafana_conf_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
         grafana_provisioning_path = os.path.join(grafana_conf_dir, 'grafana_conf/provisioning')
         grafana_config_path = os.path.join(grafana_conf_dir, 'grafana_conf/config/grafana.ini')
-        grafana_dashboard_path = os.path.join(grafana_conf_dir, 'grafana_conf/dashboards')
+        grafana_dashboard_path = os.path.join('.', 'grafana_dashboards')
         returned_string = docker.run(image='grafana/grafana:latest', name='grafana', hostname='grafana',
                                      detach=True, restart='always', tty=True, interactive=True,
                                      publish=[(3100, 3000)], pull='missing',
@@ -154,6 +157,7 @@ def stop_network(network_name):
 
 
 def start_metric_servers():
+    # TODO 检查相应容器是否已启动，如果启动，则先删除
     start_network('metric_servers')
     sleep(0.5)
     start_prometheus()
@@ -233,7 +237,7 @@ def cli():
 @click.option('-t', '--type', '_type',
               default='all',
               show_default=True,
-              type=click.Choice(['all', 'rpc', 'event', 'http', 'timer', 'demo'], case_sensitive=False),
+              type=click.Choice(INIT_TYPE_CHOICES, case_sensitive=False),
               help='The template type of nameko service')
 def init(directory, _type):
     """
@@ -258,7 +262,7 @@ def init(directory, _type):
 @cli.command()
 @click.option('-m', '--middleware',
               required=True,
-              type=click.Choice(['rabbitmq', 'metrics'], case_sensitive=False),
+              type=click.Choice(MIDDLEWARE_CHOICES, case_sensitive=False),
               help='The middleware name')
 def start(middleware):
     """
@@ -271,7 +275,7 @@ def start(middleware):
 @cli.command()
 @click.option('-m', '--middleware',
               required=True,
-              type=click.Choice(['rabbitmq', 'metrics'], case_sensitive=False),
+              type=click.Choice(MIDDLEWARE_CHOICES, case_sensitive=False),
               help='The middleware name')
 def stop(middleware):
     """
@@ -288,7 +292,7 @@ def stop(middleware):
 @click.option('-t', '--type', '_type',
               default='unit',
               show_default=True,
-              type=click.Choice(['unit'], case_sensitive=False),
+              type=click.Choice(TEST_TYPE_CHOICES, case_sensitive=False),
               help='The test type of the nameko service')
 def test_gen(directory, _type):
     """
@@ -319,13 +323,12 @@ def metric_config_gen(module, class_name_str):
     """
     import sys
     from statsd.client.timer import Timer
-    sys.path.append(os.getcwd()) 
+    sys.path.append(os.getcwd())
-    click.echo(f'sys.path: {sys.path}')
 
     # Extract information of statsd config from the class of nameko service
-    dest_dir = module.split('.')[0]
     file_name = module.split('.')[-1]
     _module = __import__(module)
+
     config_list = []
     for class_name in class_name_str.split(','):
         members = inspect.getmembers(getattr(getattr(_module, file_name), class_name), predicate=inspect.isfunction)
@@ -342,24 +345,30 @@ def metric_config_gen(module, class_name_str):
                 })
 
     # Generate one file of statsd config yaml for statsd exporter
-    metric_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
+    with status(f'Creating statsd_mapping.yml'):
-    template_file_path = os.path.join(metric_configs_dir, 'statsd_mapping.yml.mako')
+        metric_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
-    output_file = os.path.join('.', 'statsd_mapping.yml')
+        template_file_path = os.path.join(metric_configs_dir, 'statsd_mapping.yml.mako')
-    template_to_file(template_file=template_file_path, dest=output_file, output_encoding='utf-8',
+        output_file = os.path.join('.', 'statsd_mapping.yml')
-                     **{'config_list': config_list})
+        template_to_file(template_file=template_file_path, dest=output_file, output_encoding='utf-8',
+                         **{'config_list': config_list})
 
     # Generate files of json for grafana dashboard
-    for class_name in class_name_str.split(','):
+    if not os.access('grafana_dashboards', os.F_OK):
-        grafana_list = []
+        with status(f'Creating directory {os.path.abspath("grafana_dashboards")!r}'):
-        for config in config_list:
+            os.makedirs('grafana_dashboards')
-            if config['class_name'] == class_name:
+
-                grafana_list.append(config)
+    with status(f'Creating files of Grafana.json into the directory of grafana_dashboards'):
-        grafana_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
+        for class_name in class_name_str.split(','):
-        grafana_file_path = os.path.join(grafana_configs_dir, 'grafana.json.mako')
+            grafana_list = []
-        output_file = os.path.join(dest_dir, f'{class_name}_Grafana.json')
+            for config in config_list:
-        template_to_file(template_file=grafana_file_path, dest=output_file, output_encoding='utf-8',
+                if config['class_name'] == class_name:
-                         **{'service_name': class_name, 'uid': shortuuid.uuid(),
+                    grafana_list.append(config)
-                            'grafana_list': grafana_list})
+            grafana_configs_dir = os.path.join(get_directory('chassis-agent'), 'metric-configs')
+            grafana_file_path = os.path.join(grafana_configs_dir, 'grafana.json.mako')
+            output_file = os.path.join('grafana_dashboards', f'{class_name}_Grafana.json')
+            template_to_file(template_file=grafana_file_path, dest=output_file, output_encoding='utf-8',
+                             **{'service_name': class_name, 'uid': shortuuid.uuid(),
+                                'grafana_list': grafana_list})
 
 
 if __name__ == '__main__':

setup.py

@@ -9,7 +9,7 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='namekoplus',
-    version='0.4.0',
+    version='0.4.4',
     description='A lightweight Python distributed microservice solution',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -59,8 +59,8 @@ setup(
         'ha': ['tenacity==8.2.2',
                'cachetools==5.3.0',
                'circuitbreaker==2.0.0',
-               'statsd==4.0.1',
+               'logstash_formatter==0.5.17'],
-               'logstash_formatter==0.5.17',
+        'ob': ['statsd==4.0.1',
                'nameko-sentry==1.0.0',
                'nameko-tracer==1.4.0'],
         'apiflask': ['apiflask>=1.3.1',