audreyr/cookiecutter

A command-line utility that creates projects from cookiecutters (project templates). E.g. Python package projects, jQuery plugin projects.

Curtis H.

@CurtLH

I see that some Cookiecutter templates have a setup.py within the root directory template (not the project that is created). I imagine that this is so that Cookiecutter templates can be uploaded to PyPI, but I'm not sure what the purpose of this would be. As far as I can see in the documentation, I've only seen examples using Cookiecutters that are stored locally or in some type of repo like GitHub. But can you also pip install cookiecutter-pypackage 0.1.0 and use it that way as well?
e.g.: https://github.com/audreyr/cookiecutter-pypackage/blob/master/setup.py
https://github.com/conda/cookiecutter-conda-python/blob/master/setup.py
https://github.com/pydanny/cookiecutter-django/blob/master/setup.py

John Vandenberg

@jayvdb

@CurtLH the generated repo is ready to be used to generate a package which can be uploaded to pypi.org , or even installed using pip with pip install 'git+https://github.com/user/repo'

Curtis H.

@CurtLH

Thanks for the response. However, I'm not referring to the setup.py file that is in the generated repo, but rather in the root directory of the Cookiecutter itself. Specifically this file: https://github.com/audreyr/cookiecutter-pypackage/blob/master/setup.py

John Vandenberg

@jayvdb

Oh, now your question makes more sense ;)

gmatuck

@gmatuck

Hello, I have a doubt.... there is agood reference to use cookiecutter for a master project, within some sub-projects/folders in cookiecutter formats too, as well replicating some common resources for different projects (python files, databases, xml, etc). Thank you

gmatuck

@gmatuck

Chris Smith

@smitty1eGH

@gmatuck No, just relatively mature, I think.

gmatuck

@gmatuck

@smitty1eGH great, thank you for the response. I will try to implement this structure for multiple projects.

Daniel Roy Greenfeld

@pydanny

@gmatuck We just haven't updated that documentation. I'll get to that this week

gmatuck

@gmatuck

Thank you for the information Daniel

I am studying the documentation to learn how to handle the structure of the projects.

Curtis H.

@CurtLH

@pydanny -- any thoughts on my question a little further up regarding the purpose of a setup.py within the root directory of Cookiecutter? e.g., https://github.com/audreyr/cookiecutter-pypackage/blob/master/setup.py

gmatuck

@gmatuck

Hi, someone know any example in the Internet of cookiecutter structure containing python implementation, data manipulation (ETL), tests automation and report? My idea is to understand how to properly use cookiecutter (data science structure prefered),like an "hello world" after the cookiecutter structure is created.

Koz Ross

@kozross

I'm writing a Cookiecutter template to help me make IEEE Transactions LaTeX articles. One of the things I'd like to be able to template are authors, but I could have more than one. Is it possible for me to put a list in cookiecutter.json and then 'splice' that list into a document somehow?

Adrien

@adrienbresson

Hi every one,

I'm discovering cookicutter,

Is there a way to define cookiecutter variables (the ones in cookiecutter.json) from the pre-hook script ?

Adrien

@adrienbresson

looks like it's not possible : audreyr/cookiecutter#851

Chris Smith

@smitty1eGH

@adrienbresson Aren't the variables stored in the Jinja2 environment?

Adrien

@adrienbresson

@smitty1eGH , thanks for your answer, I wanted to edit those variables in hook scripts, but it's not possible, I ended writing an handler python script which set my values as a json to cookiecutter

Chris

@chrisbrake

Hello all
I submitted this pull request that adds a list command line option, it lists locally available templates: audreyr/cookiecutter#1096

I'm wondering if I can get some feedback on it.

Mykhailo Havelia

@Arfey

hi every one
Why know, how a can install cookiecutter template from github if github project has not standart structure? if config file of cookiecutter is not exist on root directory.
i need some like that

cookiecutter gh:username/project/tree/master/project_name/template

Fábio C. Barrionuevo da Luz

@luzfcb

if cookiecutter.json is not exist on root directory, you get a error.

https://github.com/audreyr/cookiecutter/blob/83d0d636ae483ca9397640729387d966ece93ee8/cookiecutter/repository.py#L50-L61

Daniel Roy Greenfeld

@pydanny

What @luzfcb said: If a Cookiecutter template doesn't have a cookiecutter.json file in the root of the project, then it's not a Cookiecutter template.

Mykhailo Havelia

@Arfey

thx

Sylvain Corlay

@SylvainCorlay

Hello!
I use cookiecutter to generate template projects for Julia.
One requirement for Julia packages is that the package is a git repository, and I always have to do a git init, git add, git commit to include all files generated by cookiecutter in the first commit...
Is there a means with cookiecutter to have scripted actions done besides generating the content of the directory?
Thanks!

Chris Smith

@smitty1eGH

@SylvainCorlay There's this => https://cookiecutter.readthedocs.io/en/latest/advanced/hooks.html

I'm sort of tackling the same concern of setting up the venv, and will want to do my first commit, here => https://github.com/smitty1eGH/cookiedough/blob/master/cookiedough.py

Sylvain Corlay

@SylvainCorlay

Thanks @smitty1eGH this is exactly what I was looking for!

Lucas Werkmeister

@lucaswerkmeister

Hi all! I’m working on my first cookiecutter template, but I’m stuck on the question of which license to choose for the template itself

projects created with the template will use AGPLv3 by default, but I’d like to allow users to choose a different license if they want to, so I’m not sure if such a restrictive license is appropriate for the template itself

I tried looking at some other cookiecutter templates for comparison, but most of them don’t seem to have any license on the template level :) any advice?

Lucas Werkmeister

@lucaswerkmeister

MIT license sounds like it could work as long as I clarify in the (template) README that created projects are not considered “substantial portions of the Software”… I’ll go with that for now

Chris Smith

@smitty1eGH

@lucaswerkmeister I should probably feel more passionate about licensing than I do.

Mohammed Shahid

@MDShahidnawaz_twitter

Hi I am new to both python and cookiecutter. I have installed PIP on my Windows 10 system, and also installer cookiecutter uings the command pip install --user cookiecutter

I am now unable to run cookiecutter command, on windows10 saying command not found and unrecognizable. Requesting help here

Burhan Khalid

@burhan

You need to add the Scripts folder to your PATH

Mohammed Shahid

@MDShahidnawaz_twitter

i have added the scripts folder already, due to which PIP command started working

AppData\Local\Programs\Python\Python37-32\Scripts

this is it in System variables path

can anyone help me here?

Burhan Khalid

@burhan

Did you refresh your prompt after modifying the path?

Mohammed Shahid

@MDShahidnawaz_twitter

yes, i restarted the prompt

Burhan Khalid

@burhan

did you run the command prompt as administrator?

Mohammed Shahid

@MDShahidnawaz_twitter

yes i tried that too

same result

Burhan Khalid

@burhan

it makes a difference. When you install as administrator, it will install the the Program Files folder, so you have to add that to your PATH as well.

Mohammed Shahid

@MDShahidnawaz_twitter

i have installed as pip install --user cookiecutter, and it had installed successfully. are you telling me to reinstall as a Admin and then give a try?

Michele

@michelepagot

hi all

Where communities thrive

People

Repo info

Activity