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

Refactored project structure and utilized pyproject.toml #112

Closed
wants to merge 0 commits into from

Conversation

oysteoh
Copy link

@oysteoh oysteoh commented Oct 27, 2024

I want to contribute to this HA plugin if there is a need for that.

First of all, i have an idea of cleaning up the structure a bit getting rid of setup.py and makefile replacing them with pyproject.toml. In addition i also have added the source code underneath the src folder according to best practice.

In the githubaction i have added matrix-build verifying various python versions.

Consider this a work in progress, and please give me feedback if this is something that is wanted or if this is not in line with the direction of the project.

Going forward i want to start adding more testing and also refactor functionality which is already written getting to know the code and also make it more clean.

@olalid
Copy link
Collaborator

olalid commented Oct 27, 2024

Looks interesting. I am not that knowledgeable about how this normally works, so not sure I understand all the changes.
For example, how would the release-process work with these changes, we have a "publish" target in the makefile for that currently...?
How do you actually pracitcally run e.g. the lint process when there is no makefile, is there another tool you are supposed to use instead?

@oysteoh
Copy link
Author

oysteoh commented Oct 27, 2024

I will make the publish target in github actions so the release of the software could be facilitated i.e. when there is a new release of a new version through the github tag / release system. Lint process and all of that could also be added to github actions as well ( and create endpoints for this as well in the toml file ). I can work a bit more on this if it seems interesting, if not i don't mind deleting the PR .

@olalid
Copy link
Collaborator

olalid commented Oct 27, 2024

I just want to understand how the workflow you propose would be.
You mean that creating a release here on GitHub would then trigger the publishing to pypi.org?
Would the linting happen only on GitHub, with no way to run it on local filesystem during development?

@oysteoh
Copy link
Author

oysteoh commented Oct 28, 2024

Yes, we can do publish to pypi through github so that is at least one proposal. I will update the PR with this action so you can have a look.
Linting ( and formatting ) can be done both places, i will update with that as well for you to have a look ( no promises on the timeline here 😄 )

@olalid
Copy link
Collaborator

olalid commented Oct 28, 2024

Yes, no rush :)

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

Successfully merging this pull request may close these issues.

2 participants