IN-894 Update project configuration and linting defaults #8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Why these changes are being introduced: * Simplify and harmonize project configuration and linting methods with modern and active libraries that augment one another. How this addresses that need: * Replace setup.cfg with pyproject.toml * Use updated pyproject.toml template * Use updated Makefile template * Add pre-commit hooks * Update various modules to address Ruff's lint rules * Update Pipfile to remove deprecated dev packages * Update Python version to 3.11 Side effects of this change: * Updated dependencies and deprecation of setup.cfg Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-894
ghukill
approved these changes
Oct 13, 2023
There was a problem hiding this comment.
Looks good to me! Thanks for updating these templates.
I know we still have some open questions about configuring python projects, and maybe there are some extremely low level integration tests we could add (e.g. ping the deployed lambda). But I'd vote to move these agreed upon changes through, and tackle those separately.
ehanson8
approved these changes
Oct 13, 2023
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Update the Python CLI template to include the latest (and greatest 🎉 ) of the DataEng team's standards for Python project code linting, formatting, and security checks. We recently revisited our current practices and made the following key decisions:
Helpful background context
The team has created some Confluence documentation around these decisions:
.dockerignorefile: I essentially copied the contents of the.gitignorefile. My assumption was that many of the files we don't want to commit to Github are also files that we don't want to include in a Docker container (e.g. cache files, .env files).How can a reviewer manually see the effects of these changes?
make installIncludes new or updated dependencies?
YES
What are the relevant tickets?
https://mitlibraries.atlassian.net/browse/IN-894
Developer
Code Reviewer
(not just this pull request message)