Skip to content

Migrate to better coding practices - #11

Merged
adriente merged 16 commits into
mainfrom
good-practices
Jul 29, 2026
Merged

Migrate to better coding practices#11
adriente merged 16 commits into
mainfrom
good-practices

Conversation

@perrymok

@perrymok perrymok commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

this pr aims at improving the coding practices in this repo that are either not recommended or outdated. changes will roll out one by one and i will explain afterwards, and you can decide to keep them or not.

this pr will not change the user experience (no codes will be changed), and only focuses on the structure of the repo, so that future maintenance will be easier.

@perrymok perrymok self-assigned this Jul 9, 2026
@perrymok perrymok added the enhancement New feature or request label Jul 9, 2026
@perrymok

perrymok commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator Author

the first change is code formatting and linting. i have added some ruff linting rules to pyproject.toml, and the .pre-commit-config.yaml file. if any future contributor has ruff or pre-commit set up, their code will automatically be formatted.

@perrymok

perrymok commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator Author

fixed github auto test workflows so that people's inboxes won't get spammed every time they commit.

@perrymok

Copy link
Copy Markdown
Collaborator Author

instead of manually changing __version__ in espm/__init__.py, it will automatically assign the value using the current git tag.

@adriente

Copy link
Copy Markdown
Owner

Just a suggestion : Could you add a pyqt6 and a pyqt5 option for backend ? With by default pyqt5 (I believe it works on more computers than pyqt6).

@perrymok

Copy link
Copy Markdown
Collaborator Author

ye absolutely, gui should be an optional dep

@perrymok

Copy link
Copy Markdown
Collaborator Author

@adriente i think the choice of pyqt5 or pyqt6 depends on your desktop environment. pyqt5 makes my jupyter kernel panic

@perrymok
perrymok marked this pull request as ready for review July 22, 2026 16:25
@perrymok
perrymok requested a review from adriente July 22, 2026 16:25
@perrymok

perrymok commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator Author

Since the first commit is just formatting code, for a better diff, please see here.

@adriente

Copy link
Copy Markdown
Owner

I didn't check fully, but as you said it is mostly formatting. I am merging it.

@adriente
adriente merged commit 6b283a5 into main Jul 29, 2026
10 checks passed
@perrymok
perrymok deleted the good-practices branch July 29, 2026 14:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants