build!: Declarative builds via pyproject.toml #17174
Merged
Conversation
This file contains 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
There was an attempt to switch to declarative setup, which was to use setup.cfg. However, we've made more progress in the "world of packaging" since. Also, given we're using a pyproject file already to govern certain aspects of our project maintenance, it's probably a good time to bring these things together. bye-bye to clutter and confusion in maintaining multiple files and formats. We've used setuptools to package frappe for the longest time. Maybe since the first editable installation. Howver setuptools doesn't support PEP 660 yet which supports editable installs via pyproject file. So why now? Primarily because I wanted to start tracking system dependencies for Frappe. Doing so through pyproject file made the most sense. This change seemed to be the obvious pre-requisite for the upcoming changes to our packaging systems. Sys deps tracking: frappe#13811 Flit docs: https://flit.pypa.io/en/latest/pyproject_toml.html Previous attempt: frappe#10773 Which build tool: https://stackoverflow.com/a/69711730/10309266 PEP 660: https://peps.python.org/pep-0660/
gavindsouza
requested review from
a team and
shariquerik
and removed request for
a team
|
Oops, gotta make bench ready for this first 😿 |
gavindsouza
changed the title
Codecov Report
@@ Coverage Diff @@
## develop #17174 +/- ##
===========================================
- Coverage 54.45% 52.82% -1.64%
===========================================
Files 754 752 -2
Lines 67782 67742 -40
Branches 5769 5765 -4
===========================================
- Hits 36910 35783 -1127
- Misses 26822 27813 +991
- Partials 4050 4146 +96
Flags with carried forward coverage won't be shown. Click here to find out more. |
setup.py is maintained so that there is no hard dependency on bench v5.11.0 and people get enough time to update their CLI. Hope the TODO adds a subtle reminder for the future ;)
gavindsouza
force-pushed
the
pyproject-filt
branch
from
ce71cac
to
cb28af8
Compare
|
Frappe is now compatible with bench v5.11.0 even without |
ankush
reviewed
Jun 15, 2022
gavindsouza
force-pushed
the
pyproject-filt
branch
2 times, most recently
from
19ec394
to
1c6b6e1
Compare
- Cache invalidated if any of the files change: *requirements.txt, pyproject.toml, setup.py or setup.cfg - Updated boilerplate for new apps too
gavindsouza
force-pushed
the
pyproject-filt
branch
from
1c6b6e1
to
1b6cc6a
Compare
gavindsouza
force-pushed
the
pyproject-filt
branch
from
e8672e7
to
21bad02
Compare
|
ERPNext CI (just in case...) - https://github.com/frappe/erpnext/actions/runs/2501569276 |
ankush
approved these changes
Jun 15, 2022
This was referenced Jun 16, 2022
51 tasks
This was referenced Jul 18, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes
Words
There was an attempt to switch to declarative setup (2 years ago), which was to use
setup.cfg. However, we've made more progress in the "world of packaging"since. Also, given we're using a
pyproject.tomlfile already to governcertain aspects of our project maintenance, it's probably a good time to
bring these things together. bye-bye to clutter and confusion in
maintaining multiple files and formats.
We've used setuptools to package frappe for the longest time. Maybe
since the first editable installation. However, setuptools doesn't support
PEP 660 yet which supports editable installs via pyproject file.
So why now? Primarily because I wanted to start tracking system
dependencies for Frappe. Doing so through pyproject file made the most
sense. This change seemed to be the obvious pre-requisite for the
upcoming changes to our packaging systems.
Refs
System dependency tracking: #13811
Moving app meta to toml: #15675
Flit docs: https://flit.pypa.io/en/latest/pyproject_toml.html
Previous attempt: #10773
Which build tool: https://stackoverflow.com/a/69711730/10309266
PEP 660: https://peps.python.org/pep-0660/