search

EntySec / SeaShell

SeaShell Framework is an iOS post-exploitation framework that enables you to access the device remotely, control it and extract sensitive information.
https://theapplewiki.com/wiki/SeaShell
MIT License
364 stars 48 forks source link

[update] Bump pylint score to ~10 #32

Open MannuVilasara opened 3 months ago

MannuVilasara commented 3 months ago

What is your question? So I recenty runned the pylint on the codebase and the results aren't that good. So is there any need to fix linting? also a workflow can be created to check wether the project really gets built, linting, formatting etc.

Additional context image

Any suggestions for the docs? can work on fixing the linting but will be a large commit (probably gonna sqash commits while merging here).

enty8080 commented 3 months ago

@MannuVilasara Do we need to have 10/10? What's the point of linting? The code is formatted following the PEP8 guidelines, I am not aware of other standards.

MannuVilasara commented 3 months ago

@MannuVilasara Do we need to have 10/10? What's the point of linting? The code is formatted following the PEP8 guidelines, I am not aware of other standards.

Yea not really a need but just a suggestion. Can be used while creating workflows

enty8080 commented 3 months ago

Okay, I'll take a look on it in a sec

enty8080 commented 3 months ago

@MannuVilasara What command did you run in pylint?

My rating is 8.94/10. Command: pylint seashell

MannuVilasara commented 3 months ago 
pylint $(git ls-files '*py')
enty8080 commented 3 months ago

I guess you need to run pylint seashell to check whole module.

MannuVilasara commented 3 months ago

Won't it just check for just the seashell file present in bin

enty8080 commented 3 months ago

No, because you are running pylint on a seashell directory (from the root of this repository). It checks for all files located in seashell

MannuVilasara commented 3 months ago

No, because you are running pylint on a seashell directory (from the root of this repository). It checks for all files located in seashell

Yea it seems like it. Got the result to be 7.9 now.

enty8080 commented 3 months ago

IDK why did you get different result. What is your python version? I guess this might be the reason (mine is 12)

P.S. Anyway, I am currently working on a Pwny official release, so fixing linting problems is not in the plan yet. However, I might take a look at it in the future. Code quality and readability is an essential part.