Support pyproject.toml #834

cjolowicz · 2019-08-24T12:03:38Z

Support PEP 517 package builds using the pyproject.toml file. This adds support for build backends other than setuptools, such as poetry and flit. This PR is a follow-up to #833.

There is not much to do here, because pip 19 already implements PEP 517-based builds.

Detect Python projects having only pyproject.toml and no requirements.txt or Pipfile.
Avoid editable installs, which are not compatible with pyproject.toml-style projects.
Add test cases for pyproject.toml-style projects managed by setuptools, poetry, and flit.

Note that while this PR does allow deploying poetry-based projects to Heroku, it does not use the pinned requirements from the poetry.lock file. Implementing support for poetry.lock is build backend-specific, and therefore left to be addressed by a follow-up PR.

See #796

Follow-ups:

Support poetry.lock #835 (Support poetry.lock)

CI is broken for PRs from another repository, see this comment. Please check the corresponding PR in my fork to verify CI:

Support pyproject.toml cjolowicz/heroku-buildpack-python#14

cjolowicz · 2019-08-25T13:32:49Z

It would be good to add a test case for a pyproject.toml using setuptools as the build backend end.

~~There could be a problem here because the buildpack uses a vendorized setuptools pinned at 39.0.1.~~ On second thoughts, this should be fine because pip will use an isolated build using the setuptools version specified in the pyproject.toml.

Update: done (f845208)

cjolowicz · 2019-09-25T08:31:00Z

Rebased onto master (v157).

Tests were moved from test/run to test/run-features

cjolowicz · 2019-10-03T15:48:55Z

Rebased onto master (af860be)

cjolowicz · 2019-11-24T14:52:34Z

Rebased onto master (93a620e)

Add two test cases for projects using poetry as the build backend: - testPoetry: project without dependencies - testPoetryLock: project with dependencies, using a poetry.lock file

Add two test cases for projects using flit as the build backend: - testFlit: project without dependencies - testFlitRequires: project with dependencies

licht1stein · 2020-04-05T16:44:57Z

Hi guys! Could you please add a comment on status of this and #796 Support for Poetry?

edmorley

Hi! Sorry for the delay in replying here. We're in the process of moving to Cloud Native Buildpacks, so all development effort is focused there at the moment, and eventually they will replace the current buildpacks. As such, we're only making minimal changes to the current buildpacks for now.

If you'd like to follow along with the development, our new CNB framework is here (which is now mostly complete):
https://github.com/heroku/libcnb.rs

And the Python CNB will (once it's beyond a local prototype), live here:
https://github.com/heroku/buildpacks-python
(My work in progress CNB has handling for pyproject.toml if it's any consolation!)

For more about CNBs, see:
https://buildpacks.io/

codingjoe

Hi @cjolowicz, thanks for the contribution. Let's try to push this over the finish line. I'd really love to use the modern project setup on Heroku.

The only thing needed to make this work, is the change in bin/detect.
Took make things easier for the maintainers, I'd suggest dropping all other changes.

I'd also recommend updating the README file. It should probably mention pyproject.toml support.

codingjoe · 2022-09-09T16:39:49Z

bin/compile

+if [ ! -f requirements.txt ] && [ ! -f Pipfile ] ; then
+    if [ -f pyproject.toml ] ; then
+        # Editable installs are not supported for pyproject.toml-style projects.
+        echo "." > requirements.txt
+    else
+        echo "-e ." > requirements.txt
+    fi


I don't think this change is needed. Editable installations are supported.

codingjoe · 2022-09-09T16:49:20Z

For everyone who needs a quick fix:

You can either add an empty setup.py file to your project or a requirements.txt file with a dot (.) in it.

cjolowicz requested a review from a team as a code owner August 24, 2019 12:03

cjolowicz force-pushed the support-pyproject-toml branch from 9011377 to f845208 Compare August 28, 2019 11:37

This was referenced Aug 28, 2019

Support poetry.lock #835

Closed

Upgrade to pip 19 #833

Merged

cjolowicz force-pushed the support-pyproject-toml branch from f845208 to 6235861 Compare August 29, 2019 09:06

cjolowicz mentioned this pull request Aug 29, 2019

Support pyproject.toml cjolowicz/heroku-buildpack-python#14

Open

cjolowicz force-pushed the support-pyproject-toml branch from 6235861 to 524f2c7 Compare September 25, 2019 08:30

cjolowicz mentioned this pull request Sep 26, 2019

Support for Poetry #796

Closed

cjolowicz force-pushed the support-pyproject-toml branch from 524f2c7 to 84534a0 Compare October 3, 2019 15:17

cjolowicz force-pushed the support-pyproject-toml branch from 84534a0 to b8ed157 Compare November 24, 2019 14:46

cjolowicz added 5 commits November 24, 2019 20:48

Support pyproject.toml when detecting Python apps

3ebeb57

Avoid editable installs for pyproject.toml-style projects

d20ddf8

Add tests for pyproject.toml-style projects using poetry

0422f56

Add two test cases for projects using poetry as the build backend: - testPoetry: project without dependencies - testPoetryLock: project with dependencies, using a poetry.lock file

Add tests for pyproject.toml-style projects using flit

7a65ab1

Add two test cases for projects using flit as the build backend: - testFlit: project without dependencies - testFlitRequires: project with dependencies

Add test for pyproject.toml-style project using setuptools

42c45ee

cjolowicz force-pushed the support-pyproject-toml branch from b8ed157 to 42c45ee Compare November 24, 2019 19:49

CaseyFaist added enhancement packaging-support-issue labels Mar 27, 2020

edmorley removed unstarted labels Jul 29, 2020

edmorley changed the base branch from master to main August 3, 2020 13:29

edmorley removed the packaging-support-issue label Apr 14, 2022

edmorley reviewed Apr 26, 2022

View reviewed changes

codingjoe reviewed Sep 9, 2022

View reviewed changes

This was referenced Jun 6, 2023

Handle pyproject.toml Scalingo/python-buildpack#80

Open

Add support for pyproject Scalingo/python-buildpack#81

Closed

phillipjf mentioned this pull request Jul 6, 2023

Feature/twitter oauth nordprojects/sirius#23

Merged

This comment was marked as off-topic.

Sign in to view

luzfcb mentioned this pull request Oct 5, 2024

Replace pip with uv for the project files cookiecutter/cookiecutter-django#5356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support pyproject.toml #834

Support pyproject.toml #834

cjolowicz commented Aug 24, 2019 •

edited

Loading

cjolowicz commented Aug 25, 2019 •

edited

Loading

cjolowicz commented Sep 25, 2019 •

edited

Loading

cjolowicz commented Oct 3, 2019

cjolowicz commented Nov 24, 2019

licht1stein commented Apr 5, 2020

edmorley left a comment

codingjoe left a comment

codingjoe Sep 9, 2022

codingjoe commented Sep 9, 2022 •

edited

Loading

This comment was marked as off-topic.

Support pyproject.toml #834

Are you sure you want to change the base?

Support pyproject.toml #834

Conversation

cjolowicz commented Aug 24, 2019 • edited Loading

cjolowicz commented Aug 25, 2019 • edited Loading

cjolowicz commented Sep 25, 2019 • edited Loading

cjolowicz commented Oct 3, 2019

cjolowicz commented Nov 24, 2019

licht1stein commented Apr 5, 2020

edmorley left a comment

Choose a reason for hiding this comment

codingjoe left a comment

Choose a reason for hiding this comment

codingjoe Sep 9, 2022

Choose a reason for hiding this comment

codingjoe commented Sep 9, 2022 • edited Loading

For everyone who needs a quick fix:

This comment was marked as off-topic.

cjolowicz commented Aug 24, 2019 •

edited

Loading

cjolowicz commented Aug 25, 2019 •

edited

Loading

cjolowicz commented Sep 25, 2019 •

edited

Loading

codingjoe commented Sep 9, 2022 •

edited

Loading