Skip to content

Add flake8 config and GitHub Actions workflow for linting.Add python linter #325

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.

Sign up for GitHub

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

Open
fahdalkhulaifi wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Add flake8 config and GitHub Actions workflow for linting.Add python linter #325

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .flake8
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[flake8]
max-line-length = 88
Copy link
Contributor

@jakebeal jakebeal Jun 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you look at https://github.com/SynBioDex/SBOL-utilities/blob/develop/setup.cfg , you will see we have been using 120 as the line length on this project.

Copy link
Contributor Author

@fahdalkhulaifi fahdalkhulaifi Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jakebeal,

As you mentioned, I’m planning to update the .flake8 config to use max-line-length = 119 to align with the project’s existing style.

Also, I wanted to ask if you recommend installing the code formatter Black as part of the workflow. I found almost 400 linting errors, so using Black might help automatically fix many of these and keep the code style consistent across the project.

Copy link
Contributor

@jakebeal jakebeal Jun 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you - I've been noticing the updated, but holding off on re-reviewing until you comment that it is ready.

With regards to Black: I've used it before, and we ended up deciding that it was too restrictive. It's a good suggestion though, and I appreciate you making the suggestion.

Copy link
Contributor Author

@fahdalkhulaifi fahdalkhulaifi Jun 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I want to share a quick update on my current approach to fixing the linting issues. I'm using the flake8 tool to identify style and syntax problems in the code, and I'm applying the fixes based on its feedback, with the help of ChatGPT to ensure the changes follow the project's style.

I'm not using any automatic code formatters like Black—instead, I'm manually addressing the issues flagged by flake8 to stay aligned with the project's conventions.

Please let me know if you have any suggestions or if you'd recommend continuing with this approach.

Thank you again for your guidance!

exclude = .venv,venv,build,dist,*.egg-info,__pycache__
24 changes: 24 additions & 0 deletions .github/workflows/lint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Python Linter

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.10'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install flake8

- name: Run flake8
run: |
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
Loading