nginx-lens 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

commands/analyze.py

@@ -15,7 +15,20 @@ console = Console()
 
 def analyze(config_path: str = typer.Argument(..., help="Путь к nginx.conf")):
     """
-    Анализирует конфигурацию Nginx на типовые проблемы. Выводит таблицу issue_type/issue_description.
+    Анализирует конфигурацию Nginx на типовые проблемы и best practices.
+
+    Показывает:
+      - Конфликты location-ов
+      - Дублирующиеся директивы
+      - Пустые блоки
+      - Потенциальные проблемы (proxy_pass без схемы, autoindex on, if, server_tokens on, SSL, лимиты, deprecated и др.)
+      - Неиспользуемые переменные
+      - Конфликты listen/server_name
+      - Проблемы с rewrite
+      - Мертвые location-ы
+
+    Пример:
+        nginx-lens analyze /etc/nginx/nginx.conf
     """
     tree = parse_nginx_config(config_path)
     conflicts = find_location_conflicts(tree)

commands/diff.py

@@ -13,6 +13,9 @@ def diff(
 ):
     """
     Сравнивает две конфигурации Nginx и выводит отличия side-by-side.
+
+    Пример:
+        nginx-lens diff /etc/nginx/nginx.conf /etc/nginx/nginx.conf.bak
     """
     tree1 = parse_nginx_config(config1)
     tree2 = parse_nginx_config(config2)

commands/graph.py

@@ -12,6 +12,10 @@ def graph(
 ):
     """
     Генерирует схему маршрутизации nginx (dot/mermaid).
+
+    Пример:
+        nginx-lens graph /etc/nginx/nginx.conf --format dot
+        nginx-lens graph /etc/nginx/nginx.conf --format mermaid
     """
     tree = parse_nginx_config(config_path)
     if format == "dot":

commands/health.py

@@ -14,6 +14,10 @@ def health(
 ):
     """
     Проверяет доступность upstream-серверов, определённых в nginx.conf. Выводит таблицу.
+
+    Пример:
+        nginx-lens health /etc/nginx/nginx.conf
+        nginx-lens health /etc/nginx/nginx.conf --timeout 5 --retries 3
     """
     tree = parse_nginx_config(config_path)
     upstreams = tree.get_upstreams()

commands/include.py

@@ -13,6 +13,10 @@ def include_tree(
 ):
     """
     Показывает дерево include-ов, циклы и shadowing директив.
+
+    Пример:
+        nginx-lens include-tree /etc/nginx/nginx.conf
+        nginx-lens include-tree /etc/nginx/nginx.conf --directive server_name
     """
     tree = build_include_tree(config_path)
     rich_tree = Tree(f"[bold blue]{config_path}[/bold blue]")

commands/logs.py

@@ -4,7 +4,7 @@ from rich.table import Table
 import re
 from collections import Counter, defaultdict
 
-app = typer.Typer()
+app = typer.Typer(help="Анализ access.log/error.log: топ-статусы, пути, IP, User-Agent, ошибки.")
 console = Console()
 
 log_line_re = re.compile(r'(?P<ip>\S+) \S+ \S+ \[(?P<time>[^\]]+)\] "(?P<method>\S+) (?P<path>\S+) [^\"]+" (?P<status>\d{3})')
@@ -15,7 +15,17 @@ def logs(
     top: int = typer.Option(10, help="Сколько топ-значений выводить")
 ):
     """
-    Анализирует access.log/error.log: топ-404, топ-500, частые запросы, подозрительные user-agent, IP.
+    Анализирует access.log/error.log.
+
+    Показывает:
+      - Топ HTTP-статусов (404, 500 и др.)
+      - Топ путей
+      - Топ IP-адресов
+      - Топ User-Agent
+      - Топ путей с ошибками 404/500
+
+    Пример:
+        nginx-lens logs /var/log/nginx/access.log --top 20
     """
     status_counter = Counter()
     path_counter = Counter()

commands/route.py

@@ -13,6 +13,9 @@ def route(
 ):
     """
     Показывает, какой server/location обслуживает указанный URL.
+
+    Пример:
+        nginx-lens route /etc/nginx/nginx.conf http://example.com/api/v1
     """
     tree = parse_nginx_config(config_path)
     res = find_route(tree, url)

commands/syntax.py

@@ -5,7 +5,7 @@ import subprocess
 import os
 import re
 
-app = typer.Typer()
+app = typer.Typer(help="Проверка синтаксиса nginx-конфига через nginx -t с подсветкой ошибок.")
 console = Console()
 
 ERROR_RE = re.compile(r'in (.+?):(\d+)')
@@ -16,7 +16,13 @@ def syntax(
     nginx_path: str = typer.Option("nginx", help="Путь к бинарю nginx (по умолчанию 'nginx')")
 ):
     """
-    Проверяет синтаксис nginx-конфига через nginx -t. В случае ошибки показывает место в виде таблицы.
+    Проверяет синтаксис nginx-конфига через nginx -t.
+
+    В случае ошибки показывает место в виде таблицы с контекстом.
+
+    Пример:
+        nginx-lens syntax /etc/nginx/nginx.conf
+        nginx-lens syntax /etc/nginx/nginx.conf --nginx-path /usr/local/sbin/nginx
     """
     cmd = [nginx_path, "-t", "-c", os.path.abspath(config_path)]
     try:

commands/tree.py

@@ -28,6 +28,11 @@ def tree(
 ):
     """
     Визуализирует структуру nginx.conf в виде дерева.
+
+    Пример:
+        nginx-lens tree /etc/nginx/nginx.conf
+        nginx-lens tree /etc/nginx/nginx.conf --markdown
+        nginx-lens tree /etc/nginx/nginx.conf --html
     """
     tree_obj = parse_nginx_config(config_path)
     root = RichTree(f"[bold blue]nginx.conf[/bold blue]")

{nginx_lens-0.1.2.dist-info → nginx_lens-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: nginx-lens
-Version: 0.1.2
+Version: 0.1.4
 Summary: CLI-инструмент для анализа, визуализации и диагностики конфигураций Nginx
 Author: Daniil Astrouski
 Author-email: shelovesuastra@gmail.com

{nginx_lens-0.1.2.dist-info → nginx_lens-0.1.4.dist-info}/RECORD

@@ -11,16 +11,16 @@ analyzer/route.py,sha256=2xxQooQEsfn10tzGCZUoP32T0OnTMnPB6qRgBR6not8,2345
 analyzer/unused.py,sha256=Ixzv0bPsw9IafblVwLiAOgugdg2dGu1MJDtuoqzPZiY,1066
 analyzer/warnings.py,sha256=zC36QMvegA2eQPvZ-P1eysrX_kXHx5A1MUKHKKNvG5c,5784
 commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-commands/analyze.py,sha256=adkc0K2VSFp4jLZQFuj_WwuBZdJkEGi0uvZyVf00EMg,3104
+commands/analyze.py,sha256=ZpChHk6QXut3S1PvslcX_4IeqdaaXtUXX-ogkB-a6GQ,3618
 commands/cli.py,sha256=0uzz71nMXTGlY1odZkEGwtVOjf7uq7762qRLXQaQURo,780
-commands/diff.py,sha256=BqrBzZJcD7XJWU0HdNos31yANvbwEWR1ZHaVowCoeV0,1282
-commands/graph.py,sha256=0_Iastpx7X8ygVsN4KUwiSIm2UCPLgm1yOq75furYJk,787
-commands/health.py,sha256=gmqeno-tADqIjO-y-LUlWhy2Nsm-K77GK5xaPV98V9w,1226
-commands/include.py,sha256=30bPFwZusvsCNjp7U2fgS9h9wWbSQlZFB6eCwzvWwok,1756
-commands/logs.py,sha256=chfwgO4KaClor_ySs_QkJ7M7q3V-5ahKFhyd5K8GOik,3128
-commands/route.py,sha256=jqGKRcocjNhGAN6LQ1PvqcNaNKG_Nn437l9ZeHaD-FA,1132
-commands/syntax.py,sha256=rABFjTHhJIumdTXSEzNlJNypZxfbXpmPlwSHkiAP7S0,2322
-commands/tree.py,sha256=H8kFYueo6mcN82MSgIzAH6Usq9u7sYo2WlY0p8rlN_A,1669
+commands/diff.py,sha256=VeZsUu1BYrDubDFrmM5xC4DUWZvWUjFRHfddXm3-I3c,1373
+commands/graph.py,sha256=xEDMAOZ9Z5gaOGqLhSIGeRlDvRfSborWwUVjk-XLCsk,930
+commands/health.py,sha256=d2bBui0qauQtO4Ll9cjniKR1Y5dYJBQzG9CECDnsUQ4,1365
+commands/include.py,sha256=zPqJpbbSU_6S3L4ntFncPmyFWba8smvdCRog_SFuAFI,1907
+commands/logs.py,sha256=NkBJAfKGXvZQDEjHwqdfYikKFMyCrEtjfDeD_MJ9ycg,3435
+commands/route.py,sha256=Rnm-zjIbos0NJjUZ0gRs27dCmUfF1tKWKVzdcFcl9hA,1224
+commands/syntax.py,sha256=TM9uOZ7MsxF78iJlajybWzouJgH2YeAbUXo8i3GxPVo,2624
+commands/tree.py,sha256=NEhNU66_e0JCsD4xh4315TM-xwo8NkPwc00lZ4saPzE,1844
 exporter/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 exporter/graph.py,sha256=WYUrqUgCaK6KihgxAcRHaQn4oMo6b7ybC8yb_36ZIsA,3995
 exporter/html.py,sha256=uquEM-WvBt2aV9GshgaI3UVhYd8sD0QQ-OmuNtvYUdU,798
@@ -29,8 +29,8 @@ parser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 parser/nginx_parser.py,sha256=JqZ3clNy4Nf-bmbsx_rJUL7EgRoB79b87eEu_isMeqg,3577
 upstream_checker/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 upstream_checker/checker.py,sha256=9-6CMUTN7gXUACP8EwX722QogfujZyV-WWWUeM3a79k,455
-nginx_lens-0.1.2.dist-info/METADATA,sha256=pRmzXAm457F0Ed7-4KY8TH9JkOWue0Zm_PdOcvyHxOE,476
-nginx_lens-0.1.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-nginx_lens-0.1.2.dist-info/entry_points.txt,sha256=qEcecjSyLqcJjbIVlNlTpqAhPqDyaujUV5ZcBTAr3po,48
-nginx_lens-0.1.2.dist-info/top_level.txt,sha256=mxLJO4rZg0rbixVGhplF3fUNFs8vxDIL25ronZNvRy4,51
-nginx_lens-0.1.2.dist-info/RECORD,,
+nginx_lens-0.1.4.dist-info/METADATA,sha256=MkC1F3wihoxkMKrTJqH0DMrgrZmtTg4L8VqbY85J0jg,476
+nginx_lens-0.1.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+nginx_lens-0.1.4.dist-info/entry_points.txt,sha256=qEcecjSyLqcJjbIVlNlTpqAhPqDyaujUV5ZcBTAr3po,48
+nginx_lens-0.1.4.dist-info/top_level.txt,sha256=mxLJO4rZg0rbixVGhplF3fUNFs8vxDIL25ronZNvRy4,51
+nginx_lens-0.1.4.dist-info/RECORD,,