Skip to content

Latest commit

 

History

History
151 lines (100 loc) · 5.82 KB

README.rst

File metadata and controls

151 lines (100 loc) · 5.82 KB

pic1



Github Workflow Build cookietemple Status Github Workflow Tests Status PyPi Status Apache 2.0 license Documentation Status Codecov Status Dependabot Enabled Zenodo ID Discord Twitter Follow

A cookiecutter based project template creation tool supporting several domains and languages with advanced linting, syncing and standardized workflows to get your project kickstarted in no time.

cookietemple overview

Installing

Start your journey with cookietemple by installing it via $ pip install cookietemple.

See Installation.

config

Configure cookietemple to get started.

https://user-images.githubusercontent.com/31141763/155188389-bfc45724-0e5f-4013-8b54-5683620e98c0.gif

See Configuring cookietemple

list

List all available cookietemple templates.

https://user-images.githubusercontent.com/31141763/155188553-a43476ce-4295-4acc-9f25-c69702b36436.gif

See Listing all templates.

info

Get detailed information on a cookietemple template.

https://user-images.githubusercontent.com/31141763/155188923-f9de27b0-22c1-479f-b720-f4a1144fbba3.gif

See Get detailed template information.

create

Kickstart your customized project with one of cookietemple's templates in no time.

https://user-images.githubusercontent.com/31141763/155189514-85c9d4e8-f16f-486b-b7e0-d8e7a3cbca93.gif

See Create a project.

lint

Use advanced linting to ensure your project always adheres to cookietemple's standards.

https://user-images.githubusercontent.com/31141763/155189594-4065538b-7955-437c-8b6c-e8f3b4cd178c.gif

See Linting your project

bump-version

Bump your project version with many configurable options.

https://user-images.githubusercontent.com/31141763/97928562-998e2a00-1d67-11eb-9651-5d7c906e2e88.gif

See Bumping the version of an existing project.

sync

Sync your project with the latest cookietemple release to get the latest template features.

https://user-images.githubusercontent.com/31141763/97928912-3c46a880-1d68-11eb-8372-8f96370a1b02.gif

See Syncing a project.

warp

Create a self contained executable. Currently, cookietemple does not ship any templates anymore, where this may be required.

See Warping a project.

upgrade

Check whether you are using the latest cookietemple version and update automatically to benefit from the latest features.

See https://cookietemple.readthedocs.io/en/latest/upgrade.html.

Projects using cookietemple

Contributing

cookietemple is a huge open-source effort and highly welcomes all contributions! Join our Discord Channel. Please read contributing to find out how you can contribute.

Authors

cookietemple was initiated and developed by Lukas Heumos (Github) and Philipp Ehmele (Github). A full list of contributors is available on our statistics webpage.