IN-1697 - update Python guidelines updates#62
Merged
Conversation
Why these changes are being introduced: The python guidelines were remarkably accurate given a fairly lengthy stay between updates, but some areas were beginning to need some updates. Additionally, we are currently actively experimenting with a "specification" of sorts for python projects, a document that is designed to be a bit more granular than these guidelines. How this addresses that need: * Updates sections where small changes are needed (e.g. pipenv -> uv) * Adds new "python projects specification" section that briefly notes and links to a specification document with more granular details about project conventions Side effects of this change: * First experimental integration of the dev docs wiki and the new python project specification repository Relevant ticket(s): * https://mitlibraries.atlassian.net/browse/IN-1697
ghukill
force-pushed
the
python-guidelines-updates
branch
from
8b842b4 to
7cd05f6
Compare
ehanson8
approved these changes
Apr 7, 2026
Contributor
ehanson8
left a comment
ehanson8
left a comment
There was a problem hiding this comment.
Looks good, 1 optional suggestion!
| These tools should be used during development and are run automatically in Github Actions during CI. They are all included in the template repositories listed above, and have integrations for common code editors to allow automatic checking and reformatting during development. | ||
|
|
||
| The linters are usually run together with the `make lint` command in a project's Makefile. See the template repositories for examples. | ||
| The linters are usually run together with the `make lint` command in a project's Makefile, which runs `ruff check`, `ruff format`, and `mypy`. See the template repositories for examples. |
Contributor
There was a problem hiding this comment.
Optional: this sentence seems ripe for getting outdated, how about just The linters are usually run together with the make lint command in a project's Makefile.
Contributor
Author
There was a problem hiding this comment.
Good call! Updating.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Why these changes are being introduced
The python guidelines were remarkably accurate given a fairly lengthy stay
between updates, but some areas were beginning to need some updates.
Additionally, we are currently actively experimenting with a "specification"
of sorts for python projects, a document that is designed to be a bit more
granular than these guidelines.
How this addresses that need:
and links to a specification document with more granular details about
project conventions
How this addresses that need
See the updated form of the python guidelines rendered here.
Side effects of this change
python project specification repository
Relevant ticket(s)