Skip to content

Commit 6349b4d

Browse files
authored
Merge pull request #103 from plone/remove-pipx
use uvx insted of pipx run. closes #102
2 parents 228c1e3 + f1789d4 commit 6349b4d

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Cookieplone offers the following key features for each audience.
3333

3434
- **One stop for all Plone templates**: Cookieplone helps you find the correct template to start your new Plone project.
3535
- **Simplified usage**: Cookieplone provides an enhanced experience over standard Cookiecutter usage by offering predefined sane defaults and a unified approach to generating various Plone projects.
36-
- **Batteries included**: No need to install lots of dependencies. Run `pipx run cookieplone`, and you will quickly generate your codebase.
36+
- **Batteries included**: No need to install lots of dependencies. Run `uvx cookieplone`, and you will quickly generate your codebase.
3737

3838

3939
### For template creators
@@ -84,18 +84,18 @@ You can also specify other templates.
8484

8585
| Template | Description | Command |
8686
| --- | --- | --- |
87-
| **backend_addon** | Create a Plone add-on to be used with the backend. | `pipx run cookieplone backend_addon ` |
88-
| **frontend_addon** | Create a Plone add-on to be used with the frontend. | `pipx run cookieplone frontend_addon ` |
87+
| **backend_addon** | Create a Plone add-on to be used with the backend. | `uvx cookieplone backend_addon ` |
88+
| **frontend_addon** | Create a Plone add-on to be used with the frontend. | `uvx cookieplone frontend_addon ` |
8989

9090
The updated list of templates can be found at the [cookieplone-templates](https://github.com/plone/cookieplone-templates) repository.
9191

9292
### Configure Cookieplone
9393

9494
| Environment Variable | Description | Example |
9595
| --- | --- | --- |
96-
| **COOKIEPLONE_REPOSITORY** | Where to look for templates to be used. | `COOKIEPLONE_REPOSITORY=/home/plone/cookieplone-templates/ pipx run cookieplone` |
97-
| **COOKIEPLONE_REPOSITORY_TAG** | Which tag/branch to use from a remote repository. | `COOKIEPLONE_REPOSITORY_TAG=experimental pipx run cookieplone` |
98-
| **COOKIEPLONE_REPO_PASSWORD** | Password to use when using a remote repository that is password protected. | `COOKIEPLONE_REPO_PASSWORD=very-secure pipx run cookieplone` |
96+
| **COOKIEPLONE_REPOSITORY** | Where to look for templates to be used. | `COOKIEPLONE_REPOSITORY=/home/plone/cookieplone-templates/ uvx cookieplone` |
97+
| **COOKIEPLONE_REPOSITORY_TAG** | Which tag/branch to use from a remote repository. | `COOKIEPLONE_REPOSITORY_TAG=experimental uvx cookieplone` |
98+
| **COOKIEPLONE_REPO_PASSWORD** | Password to use when using a remote repository that is password protected. | `COOKIEPLONE_REPO_PASSWORD=very-secure uvx cookieplone` |
9999

100100
## Contribute 🤝
101101

news/102.documentation

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace pipx with uvx in README. @gil-cano

0 commit comments

Comments
 (0)