Skip to content

Commit 8f6ef41

Browse files
113 give examples of similar projects (#475)
* Update README.md * Use URL for latest docs in link to Cookiecutter docs
1 parent bd0f724 commit 8f6ef41

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -232,6 +232,21 @@ Supported options:
232232

233233
- `--browser` to open the link in the browser automatically.
234234

235+
## 📚 Similar Projects
236+
237+
Not sure if usethis is the exact fit for your project?
238+
239+
The closest match to usethis is [PyScaffold](https://github.com/pyscaffold/pyscaffold/). It provides Command Line Interface to automate the creation of a project from a sensible templated structure.
240+
241+
You could also consider your own hard-coded template. Templating tools such as [Cookiecutter](https://github.com/cookiecutter/cookiecutter) and [Copier](https://github.com/copier-org/copier) allow you to create static templates with fixed configuration you can use across multiple projects. However, it's not always obvious which template you should use, and many do not use state-of-practice tooling such as `pyproject.toml`. Also, sometimes a template can overwhelm you with too many unfamiliar tools.
242+
243+
You could [consider this template](https://github.com/pawamoy/copier-uv) which works with Copier, or [this template](https://github.com/johnthagen/python-blueprint) which works with Cookiecutter.
244+
245+
> [!TIP]
246+
> You can still use usethis as a part of a templates using [hooks](https://cookiecutter.readthedocs.io/en/latest/advanced/hooks.html#using-pre-post-generate-hooks-0-7-0) for Cookiecutter and [tasks](https://copier.readthedocs.io/en/stable/configuring/#tasks) for Copier.
247+
248+
One of usethis's strengths is that it can update existing configuration. If you're using Cookiecutter, then you can update to a latest version of a template using a tool like [cruft](https://github.com/cruft/cruft). Copier has inbuilt support for template updating.
249+
235250
## Development
236251

237252
This project is at the early stages of development. If you are interested in contributing, please ensure you have a corresponding GitHub Issue open.

0 commit comments

Comments
 (0)