Modernize build configuration by jakob-keller · Pull Request #1160 · aio-libs/aiobotocore

jakob-keller · 2024-08-20T14:21:06Z

Description of Change

remove outdated MANIFEST.in -> gets rid of build warnings
remove arguments include_package_data and packages to setup() -> gets rid of build issues around retries sub-package
add PEP 517 / PEP 518 compatible [build-system] table to pyproject.toml
add PEP 621 compatible [project] table to pyproject.toml and merge contents of setup.py into it
update relevant documentation and unit tests

Assumptions

Follows https://packaging.python.org/en/latest/guides/modernize-setup-py-project/ (shared by @webknjaz)
setuptools is kept as build backend (for now)
I have generated pre and post distribution artefacts locally using python -m build and confirmed that they are equivalent.

Checklist for All Submissions

Checklist when updating botocore and/or aiohttp versions

I have read and followed CONTRIBUTING.rst
I have updated test_patches.py where/if appropriate (also check if no changes necessary)
I have ensured that the awscli/boto3 versions match the updated botocore version

codecov · 2024-08-20T14:24:44Z

Codecov Report

Attention: Patch coverage is 93.75000% with 1 line in your changes missing coverage. Please review.

Project coverage is 86.98%. Comparing base (2d9857b) to head (0d06dd2).
Report is 76 commits behind head on master.

Files with missing lines	Patch %	Lines
tests/test_version.py	93.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1160      +/-   ##
==========================================
- Coverage   87.03%   86.98%   -0.05%     
==========================================
  Files          64       64              
  Lines        5969     5978       +9     
==========================================
+ Hits         5195     5200       +5     
- Misses        774      778       +4

Flag	Coverage Δ
unittests	`86.98% <93.75%> (-0.05%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

thehesiod · 2024-08-20T16:57:08Z

I think setuptools is going away no? I remember now using the build module

jakob-keller · 2024-08-20T17:22:31Z

Not really: setuptools is still fully supported and maintained - as a build backend, just not as a build tool. build is a build tool that support any compatible backend. The two work hand in hand.

I am working on modernizing our build and packaging setup, which will include switching the build tool to build, while keeping setuptools as backend, at least for now. Once that setup is modernised, it will be a lot easier to switch build backends and/or tools if we decide to do so.

docs/conf.py

aiobotocore/__init__.py

MANIFEST.in

CONTRIBUTING.rst

requirements-dev.in

pyproject.toml

setup.py

pyproject.toml

…setuptools.setup()`

jakob-keller · 2024-08-21T08:16:24Z

Thank you for reviewing, @thehesiod & @webknjaz!

jakob-keller added enhancement New feature or request dependencies Pull requests that update a dependency file labels Aug 20, 2024

jakob-keller self-assigned this Aug 20, 2024

jakob-keller force-pushed the modern-packaging branch from 7ee4b77 to 0570408 Compare August 20, 2024 18:07

jakob-keller mentioned this pull request Aug 20, 2024

Rename CI/CD action to conform to aio-libs standard #1158

Merged

13 tasks

jakob-keller force-pushed the modern-packaging branch 3 times, most recently from d9f2725 to bd8e300 Compare August 20, 2024 21:52

jakob-keller changed the title ~~Modernize packaging~~ Modernize build configuration Aug 20, 2024

jakob-keller marked this pull request as ready for review August 20, 2024 22:15

jakob-keller requested review from thehesiod and webknjaz August 20, 2024 22:15

thehesiod approved these changes Aug 20, 2024

View reviewed changes