Join us on Slack

A Cloud Foundry buildpack for Python based apps.

This buildpack supports running Django and Flask apps.

Official buildpack documentation can be found at python buildpack docs.

If you want to add a new dependency to the buildpack, please add it to the config.yml file. For example, if you want to add a new version of Python, add an entry like the following:

python:
  lines:
    - line: 3.14.X
      deprecation_date: 2030-10-07
      link: https://peps.python.org/pep-0745/

The new dependency will be automatically added to the buildpack manifest.yml file.

To build this buildpack, run the following commands from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   source .envrc

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Install buildpack-packager

   go install github.com/cloudfoundry/libbuildpack/packager/buildpack-packager@latest

3. Build the buildpack

   buildpack-packager build [ --cached=(true|false) ]

4. Use in Cloud Foundry

   Upload the buildpack to your Cloud Foundry and optionally specify it by name

   cf create-buildpack [BUILDPACK_NAME] [BUILDPACK_ZIP_FILE_PATH] 1
   cf push my_app [-b BUILDPACK_NAME]

Buildpacks use the Cutlass framework for running integration tests.

To test this buildpack, run the following commands from the buildpack's directory:

1. Source the .envrc file in the buildpack directory.

   source .envrc

   To simplify the process in the future, install direnv which will automatically source .envrc when you change directories.

2. Run unit tests

   ./scripts/unit.sh

3. Run integration tests

   Buildpacks use the Cutlass framework for running integration tests against Cloud Foundry. Before running the integration tests, you need to login to your Cloud Foundry using the cf cli:

   cf login -a https://api.your-cf.com -u [email protected] -p pa55woRD

   Note that your user requires permissions to run cf create-buildpack and cf update-buildpack. To run the integration tests, run the following command from the buildpack's directory:

   ./scripts/integration.sh

4. Note: To run the network tests, you must have Docker installed.

Find our guidelines here.

Join the #buildpacks channel in our Slack community if you need any further assistance.

Open a GitHub issue on this project here.

The project backlog is on Pivotal Tracker.