You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-19Lines changed: 14 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,29 +45,25 @@ Cookieplone offers the following key features for each audience.
45
45
46
46
## Installation 💾
47
47
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.
49
49
50
50
See [how to install these and check Plone's prerequisites](https://6.docs.plone.org/install/create-project-cookieplone.html#prerequisites-for-installation).
51
+
51
52
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`:
53
53
54
-
```shell
55
-
# pipx is strongly recommended.
56
-
pipx install cookieplone
57
-
```
58
54
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:
60
58
61
59
```shell
62
-
python -m pip install --user cookieplone
60
+
uvx cookieplone
63
61
```
64
62
65
-
## Usage 🛠️
66
-
67
-
To see all available template options, run:
63
+
It is also possible to run a specific version of Cookieplone:
68
64
69
65
```shell
70
-
pipx run cookieplone
66
+
uvx cookieplone@0.9.3
71
67
```
72
68
73
69
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.
116
112
117
113
### Development requirements
118
114
119
-
- Python 3.10 or later
120
-
-[Hatch](https://hatch.pypa.io/)
115
+
-[uv](https://docs.astral.sh/uv/)
121
116
122
117
### Setup
123
118
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.
125
120
126
121
```shell
127
122
make install
@@ -130,7 +125,7 @@ make install
130
125
### Run the checked out branch of Cookieplone
131
126
132
127
```shell
133
-
hatch run cookieplone
128
+
uv run cookieplone
134
129
```
135
130
136
131
### Check and format the codebase
@@ -152,19 +147,19 @@ make test
152
147
Run all tests, but stop on the first error and open a `pdb` session with the following command.
153
148
154
149
```shell
155
-
hatch run test -x --pdb
150
+
uv run pytest -x --pdb
156
151
```
157
152
158
153
Run only tests that match `test_run_sanity_checks_fail` with the following command.
159
154
160
155
```shell
161
-
hatch run test -k test_run_sanity_checks_fail
156
+
uv run pytest -k test_run_sanity_checks_fail
162
157
```
163
158
164
159
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.
165
160
166
161
```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
0 commit comments