Pysmells
Pysmells is a tool that identifies when something doesn't 'smell right' in a python code, checking for programming errors, inconsistencies and programming style violations. It will then generate a report detailing the results of the analysis. Pysmells is based on the following Python Enhancement Proposals (PEPs): PEP 8, PEP 257 and PEP 20.
Installation
You can install pysmells using pip:
pip install pysmells
Clone this repository:
bash git clone https://github.com/pysmells/pysmells.git
Usage
To use pysmells, navigate to the directory containing the Python files you want to analyze and run the following command:
Arguments:
-p or --project: The project directory containing the subdirectories with Python files to analyze. -s or --subdirs: The list of subdirectories in the project directory, each representing a software. -csv or --csv_output: The path and file name for the CSV output report.
python pysmells.py -p /.../test -s Program1 Program2 -csv /.../report.csv
Dependencies
pysmells requires the following packages:
- tabulate
- pylint
These dependencies will be automatically installed when you install pysmells using pip.
License
pysmells is licensed under the MIT License. See the LICENSE file for more information.
2 maintainers
Metadata
2 maintainers
Release files for pysmells 1.0.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pysmells-1.0.11.tar.gz | 4.5 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| pysmells-1.0.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 11.5 kB
Release files / pysmells-1.0.11.tar.gz
| Download URL | pysmells-1.0.11.tar.gz |
|---|---|
| Size | 4.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9983c545c1e4eb4a2b6023b05eaa8a4b589c245cde108b8a9a2f02b542ec1640
|
|
BLAKE2b-256 checksum How to use checksums |
6dbaf7b4c9e2918aae69c3740c94fabcfbdbc8b904a47ae9dec2eeaa98c30f15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.4
|
Release files / pysmells-1.0.11-py3-none-any.whl
| Download URL | pysmells-1.0.11-py3-none-any.whl |
|---|---|
| Size | 7.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
de6230817ad6f5e18287ac90d38266298be07846c1736fb9c79f361f30c6fd27
|
|
BLAKE2b-256 checksum How to use checksums |
2fe80a5134f485b3e33bb5758d198349df7b3f1c2a0315f8b95f1423340ef38c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.4
|
Security for pysmells 1.0.11
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
