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

Migrate to Poetry #239

Merged
merged 10 commits into from Jul 18, 2022
Merged

Migrate to Poetry #239

merged 10 commits into from Jul 18, 2022

Conversation

Michionlion
Copy link
Member

GatorGrader has long been plagued with a non-user friendly installation interface, and this PR is the first step to rectifying this. By migrating dependency management to Poetry, we will gain more flexibility (and simplicity) in how we architect publishing GatorGrader as a Python package on PyPI, and enabling workflows like pipx run gatorgrader <some check arguments> without any extra work needed by the user.

This PR is a non-versioned change.

This work-in-progress PR has the core dependency management and GitHub Actions workflow converted to use Poetry. Before marking this as ready for review, I'd like to simplify and merge many of the configuration files to reduce cognitive load for new contributors, and simplify the root directory.

Developers

@Michionlion

@Michionlion Michionlion self-assigned this Jan 16, 2022
@Michionlion Michionlion added automation dependencies Pull requests that update a dependency file infrastructure refactor labels Jan 16, 2022
@gkapfham gkapfham self-requested a review January 19, 2022 19:35
@gkapfham
Copy link
Collaborator

Hello @Michionlion, thanks for working on this PR! I think that it is a very good idea to migrate away from Pipenv and to start using Poetry. If there is anything that I need to do in terms of testing or revising some of the configuration files, please let me know. I am glad to help with this PR if you can see a way for me to appropriately contribute. Thanks! 🚀

@Michionlion
Copy link
Member Author

@gkapfham I think this PR is pretty much ready to be merged; it replaces and fully duplicates the existing functionality, although nothing new (like publishing a package to PyPI) has been added. The only reason I've hesitated is that we'll need to update GatorGradle to either use poetry itself (which shouldn't be that difficult), or to require a published python package is installed. Either option will break existing assignments that don't have an explicit version of GatorGrader specified (which I really would like to avoid), so merging this will probably need to wait until the week between Module 1 and Module 2.

@Michionlion Michionlion changed the title WIP: Migrate to Poetry Migrate to Poetry Jul 18, 2022
@Michionlion Michionlion marked this pull request as ready for review July 18, 2022 18:55
@mariakimheinert mariakimheinert self-requested a review July 18, 2022 19:17
Copy link
Member

@mariakimheinert mariakimheinert left a comment

Choose a reason for hiding this comment

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

Looks good to me!

Copy link
Member

@mariakimheinert mariakimheinert left a comment

Choose a reason for hiding this comment

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

LGTM.

@Michionlion Michionlion merged commit a3d10c5 into master Jul 18, 2022
@Michionlion Michionlion deleted the feature/migrate-to-poetry branch July 18, 2022 20:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation dependencies Pull requests that update a dependency file infrastructure refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants