Skip to content

Commit c077603

Browse files
authored
V1 tag and deprecation (#240)
* deprecation warning * Update message and CLI call * Add to readme as well
1 parent 3978e7d commit c077603

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,20 @@ $ conda install cookiecutter
2626
### To start a new project, run:
2727
------------
2828

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

3131

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

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

3544
### The resulting directory structure
3645
------------

hooks/pre_gen_project.py

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
def deprecation_warning():
2+
print("""
3+
4+
=============================================================================
5+
*** DEPRECATION WARNING ***
6+
7+
Cookiecutter data science is moving to v2 soon, which will entail using
8+
the command `ccds ...` rather than `cookiecutter ...`. The cookiecutter command
9+
will continue to work, and this version of the template will still be available.
10+
To use the legacy template, you will need to explicitly use `-c v1` to select it.
11+
12+
Please update any scripts/automation you have to append the `-c v1` option,
13+
which is available now.
14+
15+
For example:
16+
cookiecutter -c v1 https://github.com/drivendata/cookiecutter-data-science
17+
=============================================================================
18+
19+
""")
20+
21+
22+
deprecation_warning()

0 commit comments

Comments
 (0)