Skip to content

Add cookiecutter #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 8, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Specifically, you can solve this problem by following the steps below.
- [Ruff](#ruff)
- [pre-commit](#pre-commit)
- [pytest](#pytest)
- [cookiecutter](#cookiecutter)
- [Appendix](#appendix)
- [Install libraries](#install-libraries)
- [The structure of this repository](#the-structure-of-this-repository)
Expand Down Expand Up @@ -134,6 +135,26 @@ To run the test, use the following command:
uv run pytest
```

## cookiecutter
To use cookiecutter for template, use the following command:
```sh
uv run cookiecutter {url}
```
- Data Science
- https://github.com/drivendataorg/cookiecutter-data-science
- Django
- https://github.com/cookiecutter/cookiecutter-django
- https://github.com/agconti/cookiecutter-django-rest
- https://github.com/vchaptsev/cookiecutter-django-vue
- https://github.com/chrisdev/wagtail-cookiecutter-foundation
- https://github.com/wemake-services/wemake-django-template
- FastAPI
- https://github.com/fastapi/full-stack-fastapi-template
- Flask
- https://github.com/cookiecutter-flask/cookiecutter-flask
- https://github.com/karec/cookiecutter-flask-restful
- https://github.com/italomaia/flask-empty

## Appendix

### Install libraries
Expand Down
26 changes: 26 additions & 0 deletions docs/guides/cookiecutter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# cookiecutter User Guides on this repository

!!! TIP
Official documentation for cookiecutter is available at [https://cookiecutter.readthedocs.io/en/stable/](https://cookiecutter.readthedocs.io/en/stable/)

!!! NOTE
If you do not want to use the To use cookiecutter for template, use the following command:
```sh
uv run cookiecutter {url}
```

## Example URLs
- Data Science
- https://github.com/drivendataorg/cookiecutter-data-science
- Django
- https://github.com/cookiecutter/cookiecutter-django
- https://github.com/agconti/cookiecutter-django-rest
- https://github.com/vchaptsev/cookiecutter-django-vue
- https://github.com/chrisdev/wagtail-cookiecutter-foundation
- https://github.com/wemake-services/wemake-django-template
- FastAPI
- https://github.com/fastapi/full-stack-fastapi-template
- Flask
- https://github.com/cookiecutter-flask/cookiecutter-flask
- https://github.com/karec/cookiecutter-flask-restful
- https://github.com/italomaia/flask-empty
1 change: 1 addition & 0 deletions docs/guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ How to use this repository.
- [How to use Pyright](pyright.md)
- [How to use pre-commit](pre-commit.md)
- [How to use Test](test.md)
- [How to use cookiecutter](cookiecutter.md)
- [How to use Tools](tools/index.md)
- [How to use config in this repository](tools/config.md)
- [How to use logger in this repository](tools/logger.md)
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ nav:
- Pyright: guides/pyright.md
- pre-commit: guides/pre-commit.md
- Test: guides/test.md
- cookiecutter: guides/cookiecutter.md
- tools:
- guides/tools/index.md
- config: guides/tools/config.md
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ dependencies = [

[tool.uv]
dev-dependencies = [
"cookiecutter>=2.6.0",
"mkdocs-material>=9.5.50",
"pre-commit>=4.1.0",
"pyright>=1.1.392.post0",
Expand Down
17 changes: 17 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"branchPrefix": "renovate/",
"extends": [
"config:base"
],
"lockFileMaintenance": {
"enabled": true
},
"onboarding": false,
"rebaseWhen": "behind-base-branch",
"schedule": [
"* 0-23 * * *"
],
"separateMajorMinor": false,
"timezone": "Asia/Tokyo"
}
121 changes: 121 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.