# Smelly Python
A code smell reporting tool for Python projects, created for the [Release Engineering for Machine Learning applications](https://se.ewi.tudelft.nl/remla/2022/) course at TU Delft.
Smelly Python generates an HTML report for easy viewing of Pylint errors.
# How To 1. Run pip install smelly-python 2. Run smelly-python -d {src}. Replace {src} with the directory you want to analyse. 3. Open ./report/smelly_python/index.html to view the generated report.
# Using Advanced Features of Pylint Smelly Python will run the following command: pylint {src} –output-format:json:report.json,text:grade.txt –exit-zero. Therefore, in order to customize what settings Pylint runs with, use the .pylintrc file to configure it.
# Using Smelly-Python in GitHub Actions The tool has been designed to be run within a GitHub workflow using the [smell-my-pr](https://github.com/marketplace/actions/smelly-python-smell-my-pr) GitHub action. The action will automatically post the output of the tool to your GitHub pull request as a comment and add a summary and artifact to the job.
1 maintainer
Metadata
1 maintainer
Release files for Smelly-Python 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| Smelly Python-1.0.0.tar.gz | 25.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Smelly_Python-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.4 kB
Release files / Smelly Python-1.0.0.tar.gz
| Download URL | Smelly Python-1.0.0.tar.gz |
|---|---|
| Size | 25.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
175d5d6cdac90ad56b77728b8bc4eee529c8982e1b4c57960d3eabdcb5af1e24
|
|
BLAKE2b-256 checksum How to use checksums |
45e3f15985f9d678981e08d021b0063c1d08ff677ede56f9b1f6e58d5ed2db44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
Release files / Smelly_Python-1.0.0-py3-none-any.whl
| Download URL | Smelly_Python-1.0.0-py3-none-any.whl |
|---|---|
| Size | 29.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6e535263995f94dedc6dc85c1c6a604b470cc2052da677fe01de330e48c58d8e
|
|
BLAKE2b-256 checksum How to use checksums |
dc3675e75ff4ec81fdad40e84932b6afa3345a71be79f241d9bb2364518729c8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.9.13
|
