mila-iqia / cookiecutter-pyml

MIT License
19 stars 7 forks source link

Add easy-install option for cookiecutter #124

Closed jerpint closed 2 months ago

jerpint commented 2 months ago

Provides a one-line bash script to automate most of the setup for the cookiecutter:

bash <(curl -s https://raw.githubusercontent.com/mila-iqia/cookiecutter-pyml/main/scripts/quick_install.sh) --project-name my_new_project

Note that until this gets merged, you have to use the install script from this branch to test it out or it will fail (since it's not yet on the main branch). You can try the install using the script locally like this:

 bash <(curl -s https://raw.githubusercontent.com/mila-iqia/cookiecutter-pyml/instal-script/scripts/quick_install.sh) --project-name other_new_project

The bash script will:

1) clone the cookiecutter 2) delete the previous git folder and initialize it to the new one 3) update the README to be ready for a new project

We also separate the current README into 2 READMEs:

1) The first is for the actual cookie-cutter installation 2) The second is for the newly initialized project

Apart from some instructions for the quick install, instructions in both READMEs are the same