Skip to content

Commit 13d8039

Browse files
authoredFeb 10, 2025··
Merge pull request #131 from dalito/issue129-document-poetry2
Mention poetry 2.0 requirement
2 parents 8a44d1b + b4c2b76 commit 13d8039

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed
 

‎README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,29 @@ A [Cookiecutter](https://cookiecutter.readthedocs.io/en/stable/) template for pr
77
The following are required and recommended tools for using this cookiecutter and the LinkML project that it generates. This is all one-time setup, so if you have already done it skip to the [next section](#creating-a-new-project)!
88

99
* **Python >= 3.9**
10-
11-
LinkML tools are mainly written in Python, so you will need a recent Python interpreter to run this generator and to use the generated project.
1210

11+
LinkML tools are mainly written in Python, so you will need a recent Python interpreter to run this generator and to use the generated project.
1312

1413
* **pipx**
15-
16-
pipx is a tool for managing isolated Python-based applications. It is the recommended way to install Poetry and cruft. To install pipx follow the instructions here: https://pypa.github.io/pipx/installation/
1714

15+
pipx is a tool for managing isolated Python-based applications. It is the recommended way to install Poetry and cruft. To install pipx follow the instructions here: https://pypa.github.io/pipx/installation/
1816

1917
* **Poetry**
20-
21-
Poetry is a Python project management tool. You will use it in your generated project to manage dependencies and build distribution files. If you have pipx installed ([alternative installation methods](https://python-poetry.org/docs/#installation) are available) you can install Poetry by running:
18+
19+
Poetry is a Python project management tool. You will use it in your generated project to manage dependencies and build distribution files. The template requires poetry version 2.0 or newer. If you have pipx installed ([alternative installation methods](https://python-poetry.org/docs/#installation) are available) you can install Poetry by running:
20+
2221
```shell
2322
pipx install poetry
2423
```
25-
24+
25+
- For having both Poetry 2.x and Poetry 1.x installed at the same time,
26+
pipx has the option to install another version with a suffix-modified name,
27+
here "poetry1",
28+
29+
```bash
30+
`pipx install --suffix=1 "poetry<2.0"`.
31+
```
32+
2633
This project manages project-level configuration. User-level [configuration](https://python-poetry.org/docs/configuration/), if needed, is your responsibility.
2734

2835
* **Poetry private repository**
@@ -34,7 +41,7 @@ The following are required and recommended tools for using this cookiecutter and
3441
export POETRY_PYPI_MIRROR_URL = "https://pypi-proxy.myorg.com/repository/pypi-all/simple"
3542
```
3643

37-
* **Poetry Dynamic Versioning Plugin**:
44+
* **Poetry Dynamic Versioning Plugin**:
3845

3946
This plugin automatically updates certain version strings in your generated project when you publish it. Your generated project will automatically be set up to use it. Install it by running:
4047
```shell
@@ -48,7 +55,7 @@ The following are required and recommended tools for using this cookiecutter and
4855
```shell
4956
pipx install cruft
5057
```
51-
You may also choose to not have a persistent installation of cruft, in which case you would replace any calls to the `cruft` command below with `pipx run cruft`.
58+
You may also choose to not have a persistent installation of cruft, in which case you would replace any calls to the `cruft` command below with `pipx run cruft`.
5259

5360

5461
* **make or just as command runner**

0 commit comments

Comments
 (0)
Please sign in to comment.