Skip to content

Commit 7f75e8b

Browse files
authored
Add comparison between Buildout and pip installation tools for Classic UI (#1766)
1 parent 13caea4 commit 7f75e8b

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Compare Plone Classic UI's installation tools, Buildout and pip"
5+
"property=og:description": "Compare Plone Classic UI's installation tools, Buildout and pip"
6+
"property=og:title": "Compare Buildout and pip"
7+
"keywords": "Plone 6, Conceptual guides, Classic UI, Buildout, pip, install"
8+
---
9+
10+
# Compare Buildout and pip
11+
12+
This guide explains the differences between two tools, {term}`Buildout` and {term}`pip`, to install Plone and its Classic UI user interface, helping to inform your choice when developing your new project in Plone.
13+
14+
The choice of installation tool has implications for admins and developers.
15+
16+
````{grid} 1 1 1 2
17+
:gutter: 1
18+
:margin: 0
19+
:padding: 0
20+
21+
```{grid-item-card} Buildout
22+
- You can create recipes to automate development and production installations.
23+
- Maintained and used primarily by the small Plone community.
24+
- May have problems resolving dependencies when a new pip or setuptools version is released.
25+
- Source checkouts managed through {term}`mr.developer`.
26+
```
27+
28+
```{grid-item-card} pip
29+
- Installs or uninstalls packages only.
30+
- Maintained and used by the large Python community.
31+
- Changes in dependency resolution are well-documented.
32+
- Source checkouts managed through {term}`mxdev`.
33+
```
34+
````
35+
36+
```{seealso}
37+
[Proposal: Use pip constraints as canonical version location #3670](https://github.com/plone/Products.CMFPlone/issues/3670)
38+
```

docs/glossary.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,9 @@ TC39
296296
They established a [process](https://tc39.es/process-document/) where the proposals are discussed, developed, and eventually approved (or dropped).
297297
The process has five Stages (0 to 4) where reaching the Stage 4 means the proposal is finished, and it becomes part of the JavaScript specification.
298298
299+
`mr.developer`
300+
[`mr.developer`](https://pypi.org/project/mr.developer/) is a {term}`Buildout` extension that makes it easy to work with buildouts containing lots of packages, where you only want to develop a few of them.
301+
299302
`mrs-developer`
300303
Also called "missdev", a tool similar to buildout's `mr.developer`.
301304
It automatically downloads and keeps up to date copies of software and add-ons under development based on definitions stored in `mrs.developer.json`.

docs/install/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ https://demo.plone.org/
4141
First, choose a Plone user interface, or frontend.
4242
You can read {doc}`/conceptual-guides/choose-user-interface` to help inform your choice between Volto and Classic UI.
4343

44+
If you choose Classic UI, then you can read {doc}`/conceptual-guides/compare-buildout-pip` to help inform your choice between Buildout and pip for an installation method.
45+
4446
Then choose one of the following installation methods.
4547
If you are following a [Plone training](https://training.plone.org/), it should specify which option to choose.
4648

0 commit comments

Comments
 (0)