[WIP] cookiecutter for the boilerplate #14

T4rk1n · 2018-09-27T19:42:29Z

This PR transform the repo into a cookiecutter

Try it right now with:

$ pip install cookiecutter (if not installed)
$ cookiecutter https://github.com/plotly/dash-component-boilerplate.git --checkout=cookie-cutter

Then follow the instructions in the generated README

Closes #13, closes #12, closes #9

nicolaskruchten · 2018-09-27T20:16:01Z

This is pretty cool! The readme is pretty confusing though, because it has the {{cookiecutter.project_slug}} etc in it, so if I'm just on Github reading the readme it'll seem kind of confusing?

nicolaskruchten · 2018-09-27T20:17:46Z

Maybe the readme could say under step 2 something like "the cookiecutter command will ask you some questions, including what your project "slug" is, and then it will create your project in a directory with that name, so for the rest of this README you'll need to substitute your slug wherever you see 'slug' " or something?

nicolaskruchten · 2018-09-27T20:20:40Z

I also think more guidance would be good during the Q&A step... Does cookiecutter allow us to put explanatory text throughout?

full_name [Enter name]: Nicolas Kruchten
email [Enter email]: [email protected]
description [description]: something?
project_name [my dash component]: njk_comp
project_slug [njk_comp]:
version [0.1.0]:
component_name [njk_comp]:
publish_on_npm [True]: false
Select open_source_license:
1 - MIT license
2 - BSD license
3 - ISC license
4 - Apache Software License 2.0
5 - GNU General Public License v3
6 - Not open source
Choose from 1, 2, 3, 4, 5, 6 (1, 2, 3, 4, 5, 6) [1]: 1

I wasn't sure if "full_name" was my name? the name of the project? Email... will someone send me email? Does it add me to a mailing list? How are these things used? What's the difference between description, project name and project slug? (to be clear, I know the answers to most of these, but an average user likely will not).

Finally: I know "slug" is fairly common but is kind of a gross word and a turnoff to most non-/junior-programmers I know. I would prefer "shortname" personally :)

T4rk1n · 2018-09-27T21:02:31Z

The readme is pretty confusing though

Right, I was changing alot of things in there and just copy/pasted from one to the other, I'll make the root one more readable alone.

Finally: I know "slug" is fairly common but is kind of a gross word and a turnoff to most non-/junior-programmers I know. I would prefer "shortname" personally :)

Ahah, did not think about that, the cookiecutter example used that so I just went with it.

Does cookiecutter allow us to put explanatory text throughout?

It only allows for defaults inbetween the brackets, we could put a better description in there and verify in a hook if it's still the default explanatory text.

valentijnnieman · 2018-10-01T16:06:42Z

I'm getting this error running cookiecutter [email protected]:plotly/dash-component-boilerplate.git --checkout=cookie-cutter

T4rk1n · 2018-10-01T16:23:29Z

@valentijnnieman can you try with https ?

cookiecutter https://github.com/plotly/dash-component-boilerplate.git --checkout=cookie-cutter

Answer no to install dependencies, ~~it's broken right now~~ it takes a long time.

valentijnnieman · 2018-10-01T17:03:41Z

@T4rk1n That worked, thanks :)

T4rk1n · 2018-10-15T19:00:11Z

@plotly/dash I'd like to merge this soon so we can work on more features in subsequent PR's. Please review.

Here's the files I want reviewed:

hooks/*
tests/*
both readme.
{{cookiecutter.project_shortname}}/_validate_init.py
{{cookiecutter.extract-meta.js}} -> added docstring validation.

chriddyp · 2018-10-15T22:30:08Z

{{cookiecutter.project_shortname}}/README.md

@@ -0,0 +1,86 @@
+# {{cookiecutter.project_name}}
+
+This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.


I think we should move this to CONTRIBUTING.md and then have README.md contain something like:

# {{cookiecutter.project_name}} {{cookiecutter.project_name}} is a Dash component library. Get started with: 1. Install Dash and its dependencies: https://dash.plot.ly/installation 2. Run `python usage.py` 3. Visit http://localhost:8050 in your web browser ### Contributing See [CONTRIBUTING.md](/CONTRIBUTING.md)

{{cookiecutter.project_shortname}}/README.md

chriddyp · 2018-10-15T22:38:11Z

{{cookiecutter.project_shortname}}/README.md

+
+3. Test your tarball by copying it into a new environment and installing it locally:
+    ```
+    $ pip install my_dash_component-0.0.1.tar.gz


should this be templated too?

chriddyp · 2018-10-15T22:39:58Z

README.md

+    - publish_on_npm: Set to false to only serve locally from the package data.
+    - install_dependencies: Set to false to only generate the project structure.
+4. The project will be generated in the folder of `project_shortname`.
+5. Follow the directions in the generated README to start developing your new Dash component.


Could we create a little ascii-cenima recording of this process and include it here? https://asciinema.org/

I'd like to but it's not for windows, if someone wants to do it after merge and include it, I'll create an issue for it.

chriddyp · 2018-10-15T22:46:12Z

README.md

+    $ cookiecutter [email protected]:plotly/dash-component-boilerplate.git
+    ```
+3. Answer the questions about the project.
+    - project name: Clean project name, can contains spaces and special characters.


Let's say:

- Project name: This is the "human-readable" name of your project. For example, "Dash Core Components". - Component library name: This is the "python library" name of your project. By default, this is generated from your "Project name" by lowercasing the name and replacing spaces * `-` with underscores. For example, for "Dash Core Components" this would be "dash_core_components".

And just in case you missed it, let's rename "Component name" to "Component library name".

Actually, the library name is project_shortname derived from project_name, the component_name is the name of the generated initial Component.

chriddyp · 2018-10-15T22:47:32Z

README.md

+    - component name: derived from project_name, lowercase, spaces and '-' are replaced by '_', ascii only.
+    - author info: author_name and author_email for package.json metadata.
+    - description: the project description, included in package.json.
+    - version: The initial version.


could we leave this out and just default this to 0.0.1?

chriddyp · 2018-10-15T22:47:47Z

README.md

+    - author info: author_name and author_email for package.json metadata.
+    - description: the project description, included in package.json.
+    - version: The initial version.
+    - license: License type for the component lib.


component library

README.md

kmader · 2018-10-16T17:56:12Z

This looks really great!

T4rk1n added 7 commits September 26, 2018 16:46

Refactor to a cookie cutter.

19a4c47

Fix .gitignore

7d4e1cc

Support dev packages.

76f2d9f

Add requirements file.

26e59ef

Add component_name cookiecutter variable.

f2fb3e7

Update README

808c13c

Add publish_on_npm cookiecutter option to only serve locally.

eb3164d

T4rk1n requested review from valentijnnieman and nicolaskruchten September 27, 2018 19:48

This was referenced Sep 27, 2018

ImportError: No module named dash #13

Closed

Rename bundle to lib name. Add dev bundle support. #8

Closed

T4rk1n added 3 commits September 27, 2018 17:28

Use SPDX license identifiers.

1938ab9

Rename slug to shortname, add verify step.

902a608

Update readme.

d35d4b5

T4rk1n force-pushed the cookie-cutter branch from afa5bb3 to d35d4b5 Compare September 27, 2018 22:15

T4rk1n changed the title ~~cookiecutter for the boilerplate~~ [WIP] cookiecutter for the boilerplate Sep 28, 2018

T4rk1n added 6 commits September 28, 2018 16:44

Add install dependencies step.

3e70693

Different root README.

8e05aab

Remove virtualenv install from hook.

634ae3c

Fix extra space in package.json license.

802cb73

Add warning if install_dependencies is false.

10e0679

Add package.json generation test.

19727fc

Fix npm install of generated project.

cf97743

This was referenced Oct 11, 2018

Watch mode to rebuild all files & restart everything on file changes #16

Closed

Move extract-meta into its own NPM module #17

Closed

wilzbach mentioned this pull request Oct 11, 2018

Add auto-generated files in <my_dash_component> to the .gitignore #19

Closed

T4rk1n added 6 commits October 11, 2018 17:53

Remove unused imports from demo.

34e6b9f

Remove unused from test, add comments.

cb37408

Add pytest-dash usage comment in the generate test.

1acb39d

Replace test command.

d5f1bc3

Update generated readme from #18.

08bddf0

Add more info to the cookiecutters variable in root readme.

cfeaddc

chriddyp reviewed Oct 15, 2018

View reviewed changes

{{cookiecutter.project_shortname}}/README.md Show resolved Hide resolved

chriddyp reviewed Oct 15, 2018

View reviewed changes

README.md Show resolved Hide resolved

chriddyp approved these changes Oct 15, 2018

View reviewed changes

T4rk1n added 6 commits October 16, 2018 10:59

Interpolate missing project_name.

6a65741

Remove version interpolations, start at 0.0.1

6bf9ca4

lib->library

e468ff4

Move more resources to root readme.

a0cdd16

Add getting started, add generated CONTRIBUTING.md

ea65800

Improve readme cookiecutter variables explanation.

ab9263d

T4rk1n merged commit fb64516 into master Oct 16, 2018

T4rk1n deleted the cookie-cutter branch October 16, 2018 15:39

This was referenced Oct 16, 2018

npm run scripts: wait for the spawned process to finish #15

Closed

fix webpack-cli error by upgrading the version #21

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[WIP] cookiecutter for the boilerplate #14

[WIP] cookiecutter for the boilerplate #14

T4rk1n commented Sep 27, 2018 •

edited

Loading

nicolaskruchten commented Sep 27, 2018

nicolaskruchten commented Sep 27, 2018

nicolaskruchten commented Sep 27, 2018

T4rk1n commented Sep 27, 2018

valentijnnieman commented Oct 1, 2018

T4rk1n commented Oct 1, 2018 •

edited

Loading

valentijnnieman commented Oct 1, 2018

T4rk1n commented Oct 15, 2018

chriddyp Oct 15, 2018

chriddyp Oct 15, 2018

chriddyp Oct 15, 2018

T4rk1n Oct 16, 2018

chriddyp Oct 15, 2018 •

edited

Loading

T4rk1n Oct 16, 2018

chriddyp Oct 15, 2018

chriddyp Oct 15, 2018

kmader commented Oct 16, 2018

		@@ -0,0 +1,86 @@
		# {{cookiecutter.project_name}}

		This project was generated by the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate) it contains the minimal set of code required to create your own custom Dash component.

[WIP] cookiecutter for the boilerplate #14

[WIP] cookiecutter for the boilerplate #14

Conversation

T4rk1n commented Sep 27, 2018 • edited Loading

nicolaskruchten commented Sep 27, 2018

nicolaskruchten commented Sep 27, 2018

nicolaskruchten commented Sep 27, 2018

T4rk1n commented Sep 27, 2018

valentijnnieman commented Oct 1, 2018

T4rk1n commented Oct 1, 2018 • edited Loading

valentijnnieman commented Oct 1, 2018

T4rk1n commented Oct 15, 2018

chriddyp Oct 15, 2018

Choose a reason for hiding this comment

chriddyp Oct 15, 2018

Choose a reason for hiding this comment

chriddyp Oct 15, 2018

Choose a reason for hiding this comment

T4rk1n Oct 16, 2018

Choose a reason for hiding this comment

chriddyp Oct 15, 2018 • edited Loading

Choose a reason for hiding this comment

T4rk1n Oct 16, 2018

Choose a reason for hiding this comment

chriddyp Oct 15, 2018

Choose a reason for hiding this comment

chriddyp Oct 15, 2018

Choose a reason for hiding this comment

kmader commented Oct 16, 2018

T4rk1n commented Sep 27, 2018 •

edited

Loading

T4rk1n commented Oct 1, 2018 •

edited

Loading

chriddyp Oct 15, 2018 •

edited

Loading