refactor!: restructure project to use proper src-layout #844
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
CyanVoxel
added
Type: Refactor
Computerdores
approved these changes
Mar 8, 2025
|
This became a big refactor almost accidentally. Initially the change was going to be regarding having one proper pip module, which showed the problem with the existing layout. Of course, in changing both of these things, that propagates throughout, essentially, the entire project. All to say, any other changes done are to facilitate that adjustment. There is no other upheaval planned for this PR outside accomplishing that initial task. |
Computerdores
approved these changes
Mar 9, 2025
Closed
Closed
Fixes: #200 Fixes: #365 Fixes: #512 Fixes: #800 fix(pyproject): resolve mix-up of mypy and pytest chore(ci): remove legacy scripts chore: format with new mypy rules; fix translation test wip(ci/mypy): remove config flag fix(pyinstaller): use correct dict access fix(resources): usage in ts_qt.py feat(nix/package): validate tests with pytest hook fix(nix/package): remove old dependency patch feat(nix): support Darwin fix(nix/package): move check deps to checkInputs fix(nix/shell): typo fix(nix/shell): correctly wrap Python with Qt args fix(pyproject): specify mypy-extensions feat(nix/package): provide pillow-jxl-plugin nix(nix/package): split into multiple files, allow overriding of JXL and vtf2img fix(nix/shell): provide FFmpeg on runtime feat(flake): output pillow-jxl-plugin and vtf2img fix(nix/package): load pipewire feat(nix/package): run tests on pillow-jxl-plugin fix: remove extra noqa comment docs: update installation docs docs: shrink table size on docs site nit(nix/package): pipewire not needed in buildInputs docs: update commands, environment, setup fix: use consistent possessives chore: format with prettier, add ignore flags fix(pyinstaller): consume from pyproject Revert "fix(pyinstaller): consume from pyproject" This reverts commit 398cd4e. refactor: use icon from resource manager Also fixes incorrect path currently used in ts_qt.py. nix(pyinstaller): replace use of sys.platform with platform.system docs: add build section Co-authored-by: Travis Abendshien <46939827+CyanVoxel@users.noreply.github.com>
xarvex
force-pushed
the
layout-refactor-1
branch
from
6ae67d0 to
55bc7aa
Compare
|
Manually squashed, as there has to be two commits for git history to be preserved for each file: one for the rename, and another for changes done. |
github-project-automation
bot
moved this from 🍃 Pending Merge
to ✅ Done
in TagStudio Development
This was referenced Mar 10, 2025
3 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.
Summary
This PR introduces a large refactor that moves files in order to properly align with what should be a proper "src-layout". A standard Python project layout is what was intended from the start of this project, but after a deeper level of research combined with a number of ongoing issues has made it clear that the current project structure is not only incorrect, but actively causes issues in a number of areas.
Changes
This PR introduces the following changes:
requirements.txtandrequirements-dev.txttopyproject.tomland deleted the former filespyproject.tomlalong with other code de-duplication and improvmentstagstudioin place ofsrcWhy?
This refactor fixes a number of longstanding issues while opening up the door for new development QoL features and Python-specific packaging.
tagstudio.src.orsrc.pyproject.tomlinstead of duplicating them in the workflow files and letting the versions get out of syncpip, both for users and developersTasks Completed
Closes #200, Closes #365, Closes #512, Closes #800