Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add flake8 check #263

Open
refeed opened this issue Oct 29, 2018 · 16 comments · May be fixed by #305
Open

Add flake8 check #263

refeed opened this issue Oct 29, 2018 · 16 comments · May be fixed by #305

Comments

@refeed
Copy link

refeed commented Oct 29, 2018

kiwix-build mainly comprises of Python codes, I think it'd be nice if this repository had a flake8 (which checks for codestyle and possible errors and bug (such as unused var, etc)) check in its Travis-CI.

@kelson42
Copy link
Contributor

@refeed Why not, would be be able to make a PR to introduce it?

@refeed
Copy link
Author

refeed commented Mar 24, 2019

@refeed Alright, I'm gonna make a PR for it

refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 24, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 25, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 25, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 25, 2019
@refeed refeed linked a pull request Mar 25, 2019 that will close this issue
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 26, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 26, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 26, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 26, 2019
refeed added a commit to refeed/kiwix-build that referenced this issue Mar 26, 2019
@stale
Copy link

stale bot commented Dec 14, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be now be reviewed manually. Thank you for your contributions.

@stale stale bot added the stale label Dec 14, 2019
@HimanshuMahto
Copy link

is it still open if then i would like to work on it.

@stale stale bot removed the stale label Mar 3, 2023
@kelson42
Copy link
Contributor

kelson42 commented Mar 4, 2023

@HimanshuMahto yes you can

@Rayan-Rasheed
Copy link

Is this issue still open? Because I want to work on it.

@kelson42
Copy link
Contributor

kelson42 commented Mar 7, 2023

@mgautierfr ?

@mgautierfr
Copy link
Member

The issue is still open. But I strongly suggest that @Rayan-Rasheed and @HimanshuMahto discuss together before doing both the same work.
On my side I don't care about who does it. I will review the first PR coming (and accept the first acceptable one). I don't which to review to almost identical PR.

@Vishnurr2k01
Copy link

is this issue still available ?

@mgautierfr
Copy link
Member

Yes.

@Anandbrewery
Copy link

is this issue still open?
i am interested to contribute for this

@kelson42
Copy link
Contributor

Yes, I still want to have a formalism check of the Python code... but we should probably revide a bit the requirements. @benoit74 @rgaudin Could you please tell what should be respected to respect our standards? Maybe you could also point to a place where the check workflow ismproperly implemented already?

@rgaudin
Copy link
Member

rgaudin commented Dec 30, 2024

https://github.com/openzim/_python-bootstrap is our bootstrap repo for Python project. The workflows are explicit I believe and rely on a couple things:

  • replacing the setup.py and MANIFEST.in with a pyproject.toml file that both describes the project and configures all tools
  • a tasks.py file that contains the logic for those always-similar checks.

Once in place, we have 3 main checks:

  • lint:all that checks linting using black and ruff`.
  • check:all that runs the type checker
  • test:coverage that runs the tests and outputs the coverage as well.

The first one is the only one discussed and wanted here. I think check might be wanted later but it's an effort to fix and requires good knowledge of the codebase to not break anything. There are no tests as you know so the tests and coverage parts are useless as well.

I would thus suggest to keep the bootstrap config, copy the whole tasks.py but tweak the workflow to only run linting.

It's not trivial but it shouldn't be difficult.

@kelson42
Copy link
Contributor

@rgaudin Thank you!
@Anandbrewery Still motivated?

@Anandbrewery
Copy link

Yes I'm and Happy new year 2025!

if i am stuck whom should i reach out @kelson42 @rgaudin

@rgaudin
Copy link
Member

rgaudin commented Jan 1, 2025

Myself

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

8 participants