BruceEckel / HelloCookieCutter1

The most basic template, for learning about Cookiecutter
20 stars 9 forks source link

Show directory structure of HelloCookieCutter1 example #5

Open russHyde opened 5 years ago

russHyde commented 5 years ago

Hi. Having never used cookiecutter before I found the tutorial very helpful.

I did get lost at one point due to storing cookiecutter.json as HelloCookieCutter1/{{cookiecutter.directory_name}}/cookiecutter.json instead of HelloCookieCutter1/cookiecutter.json.

Your tutorial is quite explicit that cookiecutter.json should go in HelloCookieCutter1/, but it still seems a simple mistake to make. cookiecutter itself gave a relatively uninformative error message:

Received error:                                                                               
    A valid repository for "HelloCookieCutter1/" could not be found in the                    
    following locations:                                                                      
    HelloCookieCutter1/                                                                       
    /home/ah327h/.cookiecutters/HelloCookieCutter1/

I was wondering whether you could put words to the effect of

The directory structure of our `cookiecutter` template should now look like this:
HelloCookieCutter1
    - cookiecutter.json
    - {{cookiecutter.directory_name}}
        - {{cookiecutter.file_name}}.py

into the tutorial just before the line "Now we can actually run Cookiecutter and create a new project from our template..."

Happy to submit a PR if you agree. Russ

BruceEckel commented 5 years ago

This repo was incorporated into the cookiecutter main project; you should post comments and PRs there.

-- Bruce Eckel MindViewLLC.com B http://blog.bruceeckel.com/log: BruceEckel.com SoftwareArchitectureForum.com http://www.SoftwareArchitectureForum.com WinterTechForum.com http://www.WinterTechForum.com OnJava8.com http://www.OnJava8.com www.AtomicScala.com Reinventing-Business.com http://www.Reinventing-Business.com

On Fri, Dec 7, 2018 at 7:47 AM Russ Hyde notifications@github.com wrote:

Hi. Having never used cookiecutter before I found the tutorial very helpful.

I did get lost at one point due to storing cookiecutter.json as HelloCookieCutter1/{{cookiecutter.directory_name}}/cookiecutter.json instead of HelloCookieCutter1/cookiecutter.json.

Your tutorial is quite explicit that cookiecutter.json should go in HelloCookieCutter1/, but it still seems a simple mistake to make. cookiecutter itself gave a relatively uninformative error message:

Received error: A valid repository for "HelloCookieCutter1/" could not be found in the following locations: HelloCookieCutter1/ /home/ah327h/.cookiecutters/HelloCookieCutter1/

I was wondering whether you could put words to the effect of

The directory structure of our cookiecutter template should now look like this:

HelloCookieCutter1

  • cookiecutter.json
  • {{cookiecutter.directory_name}}
    • {{cookiecutter.file_name}}.py

into the tutorial just before the line "Now we can actually run Cookiecutter and create a new project from our template..."

Happy to submit a PR if you agree. Russ

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/BruceEckel/HelloCookieCutter1/issues/5, or mute the thread https://github.com/notifications/unsubscribe-auth/AA9JrMgqa4mbZNrPobZ61p3l_Cp2zE2kks5u2o2rgaJpZM4ZIrgv .

michaeljoseph commented 4 years ago

cookiecutter has integrated with a git submodule, so we'd still need to make improvements in this repo (or move the tutorial into the cookiecutter repo).