openstack/ui-cookiecutter
Code Issues Proposed changes

Clean up cookiecutter settings

Browse Source 
To generate plugin easier using example parameters without manual
input, this patch moves descriptions for each parameters in
cookiecutter.json into README. Also add cookiecutter command
sample for '--no-input' option.

Change-Id: I1336ed66ddc1513892a0560a0af29f328da788d1
This commit is contained in:
Shu Muto 2016-11-30 12:51:28 +09:00
parent b13c9f78c8
commit 7a43095d36
2 changed files with 38 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.rst
View File

@ -26,6 +26,28 @@ Generate a Python package project::
cookiecutter https://github.com/openstack/ui-cookiecutter.git
This command prompts interactive input. Please check these parameters::
* "repo_group": The name for the git repo group. e.g. "openstack"
* "repo_name": The name for the git repo. e.g. "cafe-ui",
* "launchpad_project": The name of the project on launchpad. e.g. "cafe-ui",
* "project_short_description": The short descriptions for your UI. e.g. "Cafe User Interface",
* "help_name": The name for the help. e.g. "Cafe-UI",
* "call_by_name": The name of this UI to write texts such as README or Help. e.g. "Cafe UI",
* "module_name": The name of the python module. e.g. "cafe-ui"
* "module_folder": The name for the module folder. e.g. "cafe_ui",
* "dashboard": The slug of the "dashboard" you want to add this plugin into. e.g. "project",
* "panel_group": The slug for the "panel_group". e.g. "cafe",
* "panel_group_name": The caption for the "panel_group". e.g. "Cafe",
* "panel": The slug of the "panel", in singular. e.g. "drink",
* "panel_func": The function name for the "panel", in singular. e.g. "Drink",
* "api_module": The name of the API service module. e.g. "cafe",
* "api_name": The caption for the "api_module". e.g. "Cafe"
If you want to generate without interactive input, you can use example values for these parameters as follow::
cookiecutter https://github.com/openstack/ui-cookiecutter.git --no-inputs
Run with OpenStack Horizon::
cd <repo_name>

33
cookiecutter.json
View File

@ -1,18 +1,17 @@
{
"module_name": "replace with the name of the python module. ex) cafe-ui",
"repo_group": "openstack",
"repo_name": "replace with the name for the git repo. ex) cafe-ui",
"launchpad_project": "replace with the name of the project on launchpad. ex) cafe-ui",
"project_short_description": "OpenStack Boilerplate contains all the boilerplate you need to create an OpenStack package. ex) Cafe User Interface",
"call_by_name": "replace with the name for calling in text such as README or Help. ex) Cafe UI",
"dashboard": "replace with the name of the dashboard. ex) project",
"panel_group": "replace with the name of the panel_group. ex) cafe",
"panel_group_name": "replace with the name of the panel_group. ex) Cafe",
"panel": "replace with the name of the panel in singular. ex) bay",
"panel_func": "replace with the function name for the panel in singular. ex) Drink",
"module_folder": "replace with the name of the module folder. ex) cafe_ui",
"help_name": "replace with the name of the help. ex) Cafe-UI",
"api_module": "replace with the name of the API module. ex) cafe",
"api_name": "replace with the name for calling in text. ex) Cafe"
}
"repo_group": "openstack",
"repo_name": "cafe-ui",
"launchpad_project": "cafe-ui",
"project_short_description": "Cafe User Interface",
"help_name": "Cafe-UI",
"call_by_name": "Cafe UI",
"module_name": "cafe-ui",
"module_folder": "cafe_ui",
"dashboard": "project",
"panel_group": "cafe",
"panel_group_name": "Cafe",
"panel": "drink",
"panel_func": "Drink",
"api_module": "cafe",
"api_name": "Cafe"
}