doc: update readme (#34)

README.md

@@ -1,7 +1,16 @@
 # 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
 
+## Installation
+
+```shell
+python3 -m pip install namekoplus
+```
+
+
 ## CLI Usage
 
 ### Checkout Command

namekoplus/chassis-agent/metric-configs/grafana.json.mako

@@ -28,15 +28,14 @@
   "links": [],
   "liveNow": false,
   "panels": [
-    % for grafana_dict in grafana_list:
+% for grafana_dict in grafana_list:
     {
       "aliasColors": {},
       "bars": false,
       "dashLength": 10,
       "dashes": false,
       "datasource": {
-        "type": "statsd",
+        "type": "statsd"
-        "uid": "5qrwjFCnk"
       },
       "fill": 1,
       "fillGradient": 0,
@@ -47,7 +46,7 @@
         "y": 0
       },
       "hiddenSeries": false,
-      "id": 5,
+      "id": ${loop.index},
       "legend": {
         "alignAsTable": true,
         "avg": true,
@@ -92,7 +91,7 @@
       "title": "${service_name} | ${grafana_dict['stat_name']}",
       "tooltip": {
         "shared": true,
-        "sort": 0,
+        "sort": ${loop.index},
         "value_type": "individual"
       },
       "type": "graph",
@@ -116,8 +115,13 @@
       "yaxis": {
         "align": false
       }
+
+  % if grafana_dict['is_last'] == 1:
     }
-    % endfor
+  % else:
+    },
+  % endif
+% endfor
   ],
   "refresh": "3s",
   "schemaVersion": 36,

namekoplus/command.py

@@ -27,9 +27,10 @@ def check_docker():
         click.echo('Please start docker correctly', err=True)
         raise
 
-    if not docker.compose.is_installed():
+    # TODO 目前在某些系统环境的检查不准确，暂时去除这个检查逻辑
-        click.echo('Please install docker-compose first', err=True)
+    # if not docker.compose.is_installed():
-        raise
+    #     click.echo('Please install docker-compose first', err=True)
+    #     raise
 
 
 @contextmanager
@@ -108,7 +109,7 @@ def start_statsd_agent():
 
 def start_statsd_exporter():
     with status(f'Starting statsd exporter'):
-        statsd_mapping_file_path = os.path.join('.', 'statsd_mapping.yml')
+        statsd_mapping_file_path = os.getcwd() + '/statsd_mapping.yml'
         returned_string = docker.run(image='prom/statsd-exporter:latest', name='statsd-exporter', pull='missing',
                                      detach=True, restart='always', tty=True, hostname='statsd-exporter',
                                      publish=[(9125, 9125, 'udp'), (9102, 9102)], interactive=True,
@@ -135,7 +136,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_dashboards')
+        grafana_dashboard_path = os.path.join(os.getcwd(), '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',
@@ -324,6 +325,9 @@ def metric_config_gen(module, class_name_str):
     import sys
     from statsd.client.timer import Timer
     sys.path.append(os.getcwd())
+    for root, dirs, files in os.walk(os.getcwd()):
+        for _dir in dirs:
+            sys.path.append(os.path.join(root, _dir))
 
     # Extract information of statsd config from the class of nameko service
     file_name = module.split('.')[-1]
@@ -363,6 +367,11 @@ def metric_config_gen(module, class_name_str):
             for config in config_list:
                 if config['class_name'] == class_name:
                     grafana_list.append(config)
+            for idx, grafana_dict in enumerate(grafana_list):
+                if idx + 1 == len(grafana_list):
+                    grafana_dict['is_last'] = 1
+                else:
+                    grafana_dict['is_last'] = 0
             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')

setup.py

@@ -9,7 +9,7 @@ with open(path.join(here, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='namekoplus',
-    version='0.4.1',
+    version='0.4.26',
     description='A lightweight Python distributed microservice solution',
     long_description=long_description,
     long_description_content_type='text/markdown',
@@ -50,7 +50,7 @@ setup(
     install_requires=[
         'nameko==3.0.0rc11',
         'click==8.1.5',
-        'python-on-whales==0.63.0',
+        'python-on-whales==0.64.0',
         'pytest==7.4.0',
         'mako==1.2.4',
         'shortuuid==1.0.11'
@@ -63,15 +63,7 @@ setup(
         'ob': ['statsd==4.0.1',
                'nameko-sentry==1.0.0',
                'nameko-tracer==1.4.0'],
-        'apiflask': ['apiflask>=1.3.1',
+        'schema': ['marshmallow==3.20.1'],
-                     'gevent>=22.10.2',
-                     'gunicorn==20.1.0'],
-        'rocketry': ['rocketry==2.4.0'],
-        'gutter': ['gutter==0.5.0'],
-        'mysql': ['pymysql==1.0.3',
-                  'sqlalchemy==2.0.15',
-                  'sqlacodegen==2.3.0',
-                  'alembic==1.11.1'],
         'security': ['cryptography'],
         'dev': ['environs==9.5.0']
     },