Change the package-template to use Cookiecutter #202

Cadair · 2016-11-17T15:14:24Z

This is rather a major change to the layout of the package. For motivation and more information see APE 12

EDIT: APE PR at astropy/astropy-APEs#17

eteq · 2017-02-26T21:11:20Z

A couple questions/comments from a partial review look:

Why are the instructions called "QUESTIONS.rst"? Should it instead by INSTRUCTIONS.rst?
Related to the above and to Use Cookiecutter for the package-template (APE 12) astropy-APEs#17 (comment) : are these supposed to be the one-and-only instructions? Whether they are or not, the instructions in the astropy repo (https://github.com/astropy/astropy/blob/master/docs/development/affiliated-packages.rst) will need to be updated to reflect the new procedure. Perhaps that can also have more info about the new git procedure.
The README needs to be updated to note that this is now using cookiecutter, and that the root of this repo is not the actual template. (that wasn't obvious at first glance, and it confused me until I actually read the instructions/questions)

Cadair · 2017-02-28T12:35:51Z

Why are the instructions called "QUESTIONS.rst"? Should it instead by INSTRUCTIONS.rst?

The initial idea was they are long versions of the prompts given in the "wizard" when you render the template.

Related to the above and to Use Cookiecutter for the package-template (APE 12) astropy-APEs#17 (comment) : are these supposed to be the one-and-only instructions?

As I mentioned in that thread that is possible, and I am in favour of that option.

bsipocz · 2017-02-28T17:56:03Z

.travis.yml

@@ -17,7 +17,7 @@ env:
        # to repeat them for all configurations.
        - PYTHON_VERSION=3.6
        - CONDA_DEPENDENCIES='cython astropy sphinx'
-        - PIP_DEPENDENCIES='cookiecutter gitpython'
+        - PIP_DEPENDENCIES='cookiecutter gitpython astropy_helpers'


Not important, but you can conda install the helpers, too (from the astropy channel).

I removed it because it is only needed for the template docs, which travis isn't building at the moment.

bsipocz · 2017-02-28T17:56:32Z

.travis.yml

@@ -17,7 +17,7 @@ env:
        # to repeat them for all configurations.
        - PYTHON_VERSION=3.6
        - CONDA_DEPENDENCIES='cython astropy sphinx'


is astropy and cython needed now?

the default render of the template has astropy as a install_requires and C code. So it needs it for the test build.

bsipocz · 2017-03-01T19:19:56Z

{{ cookiecutter.package_name }}/setup.cfg

@@ -36,7 +36,7 @@ select = E101,W191,W291,W292,W293,W391,E111,E112,E113,E901,E902
 exclude = extern,sphinx,*parsetab.py

 [metadata]
-package_name = {{ cookiecutter.package_name }}
+package_name = {{ cookiecutter.module_name }}


it's still called {{ cookiecutter.package_name }} above in the filename, what is the reason of changing it here?

Module name is the name of the python module where as package name is the human readable name. I.e. 'astropy' is the module name and 'Astropy' is the package name. At least that's the idea.

well, that's a bit confusing, so there will be a directory with the fancy name as well? But tbh I should probably go at this point and have a look at cookicutter manual

I suggest you run cookiecutter to see the result, it's not that confusing once you see the output I hope!

Yeap, that's on the list. Probably I'll get there tomorrow on the 🚋 to SciTog.

I am in London for SciTog, so I can talk to you about it!!

I know, and actually I want to pick your brain on a few other questions, unrelated to this :)

astrofrog · 2017-03-20T17:08:25Z

NOTE this PR should be merged manually into the cookiecutter branch, not master!

astrofrog · 2017-03-20T17:08:37Z

@Cadair - can you rebase? (astropy-helpers change)

Now uses GitPython to init the repo after templateing and then add astropy_helpers as a submodule.

Although spaces in cli args does not work!

astrofrog

APE12 is now accepted and this is mergeable, so will go ahead and merge now. @Cadair has indicated he'll work on the Travis auto-render stuff and the documentation once this is merged. Once the docs and auto-render are in place we can switch this to be the default branch.

cdeil mentioned this pull request Jan 9, 2017

Use Cookiecutter for the package-template (APE 12) astropy/astropy-APEs#17

Merged

Cadair force-pushed the cookiecutter branch from 640199f to ca28323 Compare January 11, 2017 10:59

Cadair force-pushed the cookiecutter branch 2 times, most recently from 5fd80bb to 6bfd3b0 Compare February 28, 2017 12:55

bsipocz reviewed Feb 28, 2017

View reviewed changes

bsipocz reviewed Mar 1, 2017

View reviewed changes

Cadair force-pushed the cookiecutter branch from e673a80 to 27edb6f Compare March 7, 2017 16:25

Cadair added 18 commits March 20, 2017 19:00

make package template into a cookiecutter package

6367d20

add some hidden config and fix slug bug

fb3dd53

Variable length titles for sphinx!

43f0721

More tweaks and documenation for the questions

fa9ca4c

reorder questions

b940000

replace package_slug with module_name

29dc0f4

rename folders for module_name

35c8372

Add check on astropy theme settings

24ee7eb

Fix template syntax in hook

cd5b7d6

Quite marks around theme var

6e4923b

Add docs and git work in post hook.

5189374

Now uses GitPython to init the repo after templateing and then add astropy_helpers as a submodule.

try a travis render

1bc1779

test the pacakage after creation

636d41f

not using static atm

9667c7d

fix setup.cfg merge

66f5d6a

add sphinx

cc8fc7d

astropy helpers for the theme

a17d17a

don't need helpers on travis

c4f466a

Cadair added 3 commits March 20, 2017 19:00

more fixes

6a02805

Add updating docs

df9cf84

template packagename in travis config

4dca307

Cadair force-pushed the cookiecutter branch from 27edb6f to 4dca307 Compare March 20, 2017 19:00

astrofrog changed the base branch from master to cookiecutter March 28, 2017 09:35

Cadair added 3 commits March 28, 2017 11:41

Make the C extension default to off

6e65d21

use extra context to run more tests

dc19f16

Fix tests and support spaces in package_name

fe4e2c6

Although spaces in cli args does not work!

Cadair force-pushed the cookiecutter branch 2 times, most recently from 22adf17 to 73f696d Compare March 28, 2017 12:16

Module name is not top level folder name

02113dc

Cadair force-pushed the cookiecutter branch from 73f696d to 02113dc Compare March 28, 2017 14:32

astrofrog approved these changes Mar 28, 2017

View reviewed changes

astrofrog merged commit 687974b into astropy:cookiecutter Mar 28, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change the package-template to use Cookiecutter #202

Change the package-template to use Cookiecutter #202

Cadair commented Nov 17, 2016 •

edited by pllim

Loading

eteq commented Feb 26, 2017

Cadair commented Feb 28, 2017

bsipocz Feb 28, 2017

Cadair Feb 28, 2017

bsipocz Feb 28, 2017

Cadair Feb 28, 2017

bsipocz Mar 1, 2017

Cadair Mar 1, 2017

bsipocz Mar 1, 2017

Cadair Mar 1, 2017

bsipocz Mar 1, 2017

Cadair Mar 1, 2017

bsipocz Mar 1, 2017

astrofrog commented Mar 20, 2017

astrofrog commented Mar 20, 2017

astrofrog left a comment

Change the package-template to use Cookiecutter #202

Change the package-template to use Cookiecutter #202

Conversation

Cadair commented Nov 17, 2016 • edited by pllim Loading

eteq commented Feb 26, 2017

Cadair commented Feb 28, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

astrofrog commented Mar 20, 2017

astrofrog commented Mar 20, 2017

astrofrog left a comment

Choose a reason for hiding this comment

Cadair commented Nov 17, 2016 •

edited by pllim

Loading