Code Analyzer Tool by TechBeamers
Project description
TechBeamers Code Analyzer
The TechBeamers Code Analyzer is a Python tool for analyzing Python code using PEP 8, Flake8, and MyPy. It generates comprehensive reports on code style, potential issues, and type checking.
Features
This code analyzer combines the power of the latest and top three code analysis tools. It performs a three-level analysis on the provided file, aiming to identify potential issues within your code.
- PEP 8 analysis for ensuring Python code adheres to the style guide.
- Flake8 analysis for checking code against coding standards and identifying potential issues.
- MyPy analysis for performing static type checking and highlighting type-related errors.
Installation
You can install the TechBeamers Code Analyzer using pip:
pip install techbeamers
Usage
To analyze a Python file, run the following command:
techbeamers-analyzer path/to/your/file.py
The above command will, by default, detect the programming language based on the file extension and provide you with a brief statistics summary of the specified file. To perform code analysis, ensure to provide any or a combination of the command-line options, as shown in the next section.
Options
--report-format: Format for saving detailed reports, such as html (default) or txt..--analyze-pep8: Perform PEP 8 analysis using pycodestyle.--analyze-flake8: Perform Flake8 analysis.--analyze-mypy: Perform MyPy analysis.--disable-all: Disable all analyses.--help: Display available options.
Examples
# Analyze a Python file for PEP8 and generate an HTML report
techbeamers-analyzer path/to/your/file.py --analyze-pep8 --report-format html
# Analyze a Python file using Flake8 and generate a text report
techbeamers-analyzer path/to/your/file.py --analyze-flake8 --report-format txt
# Analyze a Python file using mypy and generate default html report
techbeamers-analyzer path/to/your/file.py --analyze-mypy
# Analyze a Python file with both PEP8 and Flake8 but without mypy
techbeamers-analyzer path/to/your/file.py --analyze-pep8 --analyze-flake8
# Run all three analysis on your Python file
techbeamers-analyzer path/to/your/file.py --analyze-pep8 --analyze-flake8 --analyze-mypy
Reports
Detailed reports are generated in both HTML and TXT formats, providing insights into code quality and potential improvements. The tool saves the reports in the same folder as the target file specified for analysis.
Contributions
Contributions are welcome! Feel free to open issues, submit pull requests, or provide feedback.
License
This project is licensed under the MIT License.
About TechBeamers
TechBeamers is a platform providing tutorials, guides, and tools for developers. Visit techbeamers.com for more information.
Contact
For inquiries, please contact us at magarwal@techbeamers.com.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file techbeamers-1.0.1.tar.gz.
File metadata
- Download URL: techbeamers-1.0.1.tar.gz
- Upload date:
- Size: 6.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
65f234108d516cae1e709aa9438720a8ec4012741fe9a2c13fdfc3b2a8627cd5
|
|
| MD5 |
64aede73f6d012871696e720caeee80b
|
|
| BLAKE2b-256 |
7282ebf6c1512ff165c6fddd09162ce24c2f5a2c1cf25c72935af481e7954c28
|
File details
Details for the file techbeamers-1.0.1-py3-none-any.whl.
File metadata
- Download URL: techbeamers-1.0.1-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.10.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
32edce4023c0abaef47844ffae72773936a43ea9fd719496aef797cbf8bac2f6
|
|
| MD5 |
6a276a986ab10a37225494e4de3dfc86
|
|
| BLAKE2b-256 |
6d9349ed597daf9c273df231af9c25ee17b41df9702d72af20b9251a94ec2ad4
|