@@ -6,15 +6,12 @@ The buildpack is published for consumption at
66` gcr.io/paketo-buildpacks/pipenv-install ` and ` paketobuildpacks/pipenv-install ` .
77
88## Behavior
9- This buildpack participates if ` Pipfile ` exists at the root the app.
9+ This buildpack participates if ` Pipfile ` exists at the root of the app.
1010
1111The buildpack will do the following:
12- * At build time:
13- - Installs the application packages to a layer made available to the app.
14- - Prepends the layer site-packages onto ` PYTHONPATH ` .
15- - Prepends the layer's ` bin ` directory to the ` PATH ` .
16- * At run time:
17- - Does nothing
12+ - Installs the application packages to a layer made available to the app.
13+ - Prepends the layer site-packages onto ` PYTHONPATH ` .
14+ - Prepends the layer's ` bin ` directory to the ` PATH ` .
1815
1916This buildpack speeds up the build process by reusing (the layer of) installed
2017packages from a previous build if it exists, and later cleaning up any unused
@@ -26,9 +23,8 @@ rebuild to avoid any unused packages in the built image.
2623## Integration
2724
2825The Pipenv Install CNB provides ` site-packages ` as a dependency. Downstream
29- buildpacks can require the ` site-packages ` dependency by generating a [ Build
30- Plan
31- TOML] ( https://github.com/buildpacks/spec/blob/master/buildpack.md#build-plan-toml )
26+ buildpacks can require the ` site-packages ` dependency by generating a [ Build Plan TOML]
27+ (https://github.com/buildpacks/spec/blob/master/buildpack.md#build-plan-toml )
3228file that looks like the following:
3329
3430``` toml
@@ -42,27 +38,21 @@ file that looks like the following:
4238 # The Pipenv Install buildpack supports some non-required metadata options.
4339 [requires .metadata ]
4440
45- # Setting the build flag to true will ensure that the site-packages
46- # dependency is available on the $PYTHONPATH/$PATH for subsequent
47- # buildpacks during their build phase. If you are writing a buildpack that
48- # needs site-packages during its build process, this flag should be
49- # set to true.
41+ # Set the build flag to true to make the site-packages dependency available on the $PYTHONPATH/$PATH
42+ # for subsequent buildpacks during their build phase.
5043 build = true
5144
52- # Setting the launch flag to true will ensure that the site-packages
53- # dependency is available on the $PYTHONPATH/$PATH for the running
54- # application. If you are writing an application that needs site-packages
55- # at runtime, this flag should be set to true.
45+ # Set the launch flag to true to make the site-packages dependency available on the $PYTHONPATH/$PATH
46+ # for the running application.
5647 launch = true
5748```
5849
5950## SBOM
6051
6152This buildpack can generate a Software Bill of Materials (SBOM) for the dependencies of an application.
6253
63- However, this feature only works if the application already has a
64- ` Pipfile.lock ` file. This is due to a limitation in the upstream SBOM
65- generation library (Syft).
54+ However, this feature only works if the application already has a ` Pipfile.lock ` file.
55+ This is due to a limitation in the upstream SBOM generation library (Syft).
6656
6757Applications that declare their dependencies via a ` Pipfile ` but do not include
6858a ` Pipfile.lock ` will result in an empty SBOM. Check out the [ Paketo SBOM
@@ -75,10 +65,15 @@ To package this buildpack for consumption:
7565```
7666$ ./scripts/package.sh --version x.x.x
7767```
78- This will create a ` buildpackage.cnb ` file under the build directory which you
79- can use to build your app as follows: `pack build <app-name > -p <path-to-app >
80- -b <cpython buildpack > -b <pipenv buildpack > -b build/buildpackage.cnb -b
81- <other-buildpacks..>`.
68+ This will create a ` buildpackage.cnb ` file under the build directory which you can use to build your app as follows:
69+ ``` shell
70+ pack build < app-name> \
71+ --path < path-to-app> \
72+ --buildpack < cpython buildpack> \
73+ --buildpack < pipenv buildpack> \
74+ --buildpack build/buildpackage.cnb \
75+ --buildpack < other-buildpacks..>
76+ ```
8277
8378To run the unit and integration tests for this buildpack:
8479```
0 commit comments