Welcome to sourcery-analytics’s documentation!¶
sourcery-analytics is a library and command-line interface (CLI) for analyzing the code quality of Python
packages, modules, or source code.
Installation and Quickstart¶
Installation¶
$ pip install sourcery_analytics
Analyze a file¶
$ sourcery-analytics analyze path/to/file.py
Example¶
$ sourcery-analytics analyze sourcery_analytics/analysis.py
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━┓
┃ Method ┃ length ┃ cyclomatic_complexity ┃ cognitive_complexity ┃ working_memory ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━┩
│ sourcery_analytics.analysis.analyze │ 5 │ 1 │ 0 │ 8 │
│ sourcery_analytics.analysis.analyze_methods │ 4 │ 1 │ 1 │ 12 │
└─────────────────────────────────────────────┴────────┴───────────────────────┴──────────────────────┴────────────────┘