Skip to content

Commit

Permalink
V1 tag and deprecation (#240)
Browse files Browse the repository at this point in the history
* deprecation warning

* Update message and CLI call

* Add to readme as well
  • Loading branch information
pjbull committed Mar 20, 2021
1 parent 3978e7d commit c077603
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Expand Up @@ -26,11 +26,20 @@ $ conda install cookiecutter
### To start a new project, run:
------------

cookiecutter https://github.com/drivendata/cookiecutter-data-science
cookiecutter -c v1 https://github.com/drivendata/cookiecutter-data-science


[![asciicast](https://asciinema.org/a/244658.svg)](https://asciinema.org/a/244658)

### New version of Cookiecutter Data Science
------------
Cookiecutter data science is moving to v2 soon, which will entail using
the command `ccds ...` rather than `cookiecutter ...`. The cookiecutter command
will continue to work, and this version of the template will still be available.
To use the legacy template, you will need to explicitly use `-c v1` to select it.
Please update any scripts/automation you have to append the `-c v1` option (as above),
which is available now.


### The resulting directory structure
------------
Expand Down
22 changes: 22 additions & 0 deletions hooks/pre_gen_project.py
@@ -0,0 +1,22 @@
def deprecation_warning():
print("""
=============================================================================
*** DEPRECATION WARNING ***
Cookiecutter data science is moving to v2 soon, which will entail using
the command `ccds ...` rather than `cookiecutter ...`. The cookiecutter command
will continue to work, and this version of the template will still be available.
To use the legacy template, you will need to explicitly use `-c v1` to select it.
Please update any scripts/automation you have to append the `-c v1` option,
which is available now.
For example:
cookiecutter -c v1 https://github.com/drivendata/cookiecutter-data-science
=============================================================================
""")


deprecation_warning()

0 comments on commit c077603

Please sign in to comment.