Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cookiejar/cookietemple

A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
https://github.com/cookiejar/cookietemple

cookiecutter cpp hacktoberfest java kotlin latex project python template

Last synced: about 2 months ago
JSON representation

A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺

Awesome Lists containing this project

README 

        
|pic1|



.. |pic1| image:: https://user-images.githubusercontent.com/21954664/83797925-a7019400-a6a3-11ea-86ad-44ad00e24234.png

   :width: 75%



-----------------------------------------------------------



|



.. image:: https://github.com/zethson/cookietemple/workflows/Build%20Cookietemple%20Package/badge.svg

        :target: https://github.com/zethson/cookietemple/workflows/Build%20Cookietemple%20Package/badge.svg

        :alt: Github Workflow Build cookietemple Status



.. image:: https://github.com/cookiejar/cookietemple/actions/workflows/run_tests.yml/badge.svg

        :target: https://github.com/cookiejar/cookietemple/actions/workflows/run_tests.yml/badge.svg

        :alt: Github Workflow Tests Status



.. image:: https://img.shields.io/pypi/v/cookietemple.svg

        :target: https://pypi.python.org/pypi/cookietemple

        :alt: PyPi Status



.. image:: https://img.shields.io/github/license/cookiejar/cookietemple

        :target: https://github.com/cookiejar/cookietemple/blob/master/LICENSE

        :alt: Apache 2.0 license



.. image:: https://readthedocs.org/projects/cookietemple/badge/?version=latest

        :target: https://cookietemple.readthedocs.io/en/latest/?badge=latest

        :alt: Documentation Status



.. image:: https://codecov.io/gh/cookiejar/cookietemple/branch/master/graph/badge.svg?token=dijn0M0p7m

        :target: https://codecov.io/gh/cookiejar/cookietemple

        :alt: Codecov Status



.. image:: https://flat.badgen.net/dependabot/thepracticaldev/dev.to?icon=dependabot

        :target: https://flat.badgen.net/dependabot/thepracticaldev/dev.to?icon=dependabot

        :alt: Dependabot Enabled



.. image:: https://zenodo.org/badge/202421008.svg

        :target: https://zenodo.org/badge/latestdoi/202421008

        :alt: Zenodo ID



.. image:: https://img.shields.io/discord/708008788505919599?color=passing&label=Discord%20Chat&style=flat-square

        :target: https://discord.gg/PYF8NUk

        :alt: Discord



.. image:: https://img.shields.io/twitter/follow/cookiejarorg?color=green&style=flat-square

        :target: https://twitter.com/cookiejarorg

        :alt: 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.



* Documentation: https://cookietemple.readthedocs.io .



cookietemple overview

========================



Installing

---------------



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



See `Installation  `_.



config

------

Configure cookietemple to get started.



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



See `Configuring cookietemple `_



list

----

List all available cookietemple templates.



.. figure:: 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.



.. figure:: 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.



.. figure:: 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.



.. image:: 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.



.. figure:: 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.



.. figure:: 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 ``_.



Projects using cookietemple

---------------------------



* `cookietemple website `_

* `system-intelligence `_

* `mlf-core `_



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 `_.