Skip to content

Commit abcbe46

Browse files
committed
Update README to recommend using cookieplone via uvx
1 parent 8d962f8 commit abcbe46

File tree

2 files changed

+15
-19
lines changed

2 files changed

+15
-19
lines changed

README.md

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -45,29 +45,25 @@ Cookieplone offers the following key features for each audience.
4545

4646
## Installation 💾
4747

48-
First, ensure you have Python, pip, and pipx installed on your system.
48+
First, ensure you have [`UV`](https://docs.astral.sh/uv/getting-started/installation/) installed on your system.
4949

5050
See [how to install these and check Plone's prerequisites](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation).
51+
5152
Set up your system with [Plone's prerequisites](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation).
52-
Then install Cookieplone using `pipx`:
5353

54-
```shell
55-
# pipx is strongly recommended.
56-
pipx install cookieplone
57-
```
5854

59-
Or, if pipx is not an option, you can install Cookieplone in your Python user directory.
55+
## Usage 🛠️
56+
57+
Use `uvx` (command installed by `uv`) to run `cookieplone` and see all available template options:
6058

6159
```shell
62-
python -m pip install --user cookieplone
60+
uvx cookieplone
6361
```
6462

65-
## Usage 🛠️
66-
67-
To see all available template options, run:
63+
It is also possible to run a specific version of Cookieplone:
6864

6965
```shell
70-
pipx run cookieplone
66+
uvx cookieplone@0.9.3
7167
```
7268

7369
Cookieplone will walk you through the necessary steps, using sensible defaults and offering customization options where needed.
@@ -116,12 +112,11 @@ You can create an issue in the issue tracker, or contact a maintainer.
116112

117113
### Development requirements
118114

119-
- Python 3.10 or later
120-
- [Hatch](https://hatch.pypa.io/)
115+
- [uv](https://docs.astral.sh/uv/)
121116

122117
### Setup
123118

124-
Install all development dependencies, including Hatch, and create a local virtual environment with the following command.
119+
Install `UV`, and create a local virtual environment with the following command.
125120

126121
```shell
127122
make install
@@ -130,7 +125,7 @@ make install
130125
### Run the checked out branch of Cookieplone
131126

132127
```shell
133-
hatch run cookieplone
128+
uv run cookieplone
134129
```
135130

136131
### Check and format the codebase
@@ -152,19 +147,19 @@ make test
152147
Run all tests, but stop on the first error and open a `pdb` session with the following command.
153148

154149
```shell
155-
hatch run test -x --pdb
150+
uv run pytest -x --pdb
156151
```
157152

158153
Run only tests that match `test_run_sanity_checks_fail` with the following command.
159154

160155
```shell
161-
hatch run test -k test_run_sanity_checks_fail
156+
uv run pytest -k test_run_sanity_checks_fail
162157
```
163158

164159
Run only tests that match `test_run_sanity_checks_fail`, but stop on the first error and open a `pdb` session with the following command.
165160

166161
```shell
167-
hatch run test -k test_run_sanity_checks_fail -x --pdb
162+
uv run pytest -k test_run_sanity_checks_fail -x --pdb
168163
```
169164

170165
## Support 📢

news/+readme.documentation

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Update README to recommend using `cookieplone` via `uvx` @ericof

0 commit comments

Comments
 (0)