refactor options

README.md

@@ -60,23 +60,23 @@ $ cookiecutter gh:spyder-ide/spyder-plugin-cookiecutter
 
 You'll be prompted for some values. and after that the repo will be generated
 
-Normally you don't need to change `project_name` and `repo_name`.
+Normally you don't need to change `python_package_name` and `git_repo_name`.
 
 Example:
 
 ```
-author [Spyder Project Contributors]:
-email [[email protected]]:
+plugin_name [Demo]: 
+git_repo_name [spyder-demo]: 
+python_package_name [spyder_demo]: 
+description [Plugin for Spyder IDE.]: 
+version [0.1.0]: 
+author [Spyder Project Contributors]: 
+email [[email protected]]: 
 github_username [spyder-ide]:
-plugin_name [Demo Plugin]: Reports
-repo_name [spyder-reports]:
-project_name [spyder_reports]:
-description [Plugin for Spyder IDE.]: Spyder Plugin for Markdown reports for Pweave
-version [0.1.0]:
-create_config_page [n]:
-use_ciocheck [y]:
-support_python_2 [n]:
-spyder3_compatibility [y]:
+graphical_plugin [y]: 
+create_config_page [n]: 
+support_python_2 [n]: 
+spyder3_compatibility [n]: 
 ```
 
 ## Testing

cookiecutter.json

@@ -1,14 +1,13 @@
 {
-  "author": "Spyder Project Contributors",
-  "email": "[email protected]",
-  "github_username": "spyder-ide",
   "plugin_name": "Demo",
-  "repo_name": "spyder-{{ cookiecutter.plugin_name.lower().replace(' ', '-')}}",
-  "project_name": "{{ cookiecutter.repo_name.replace('-', '_') }}",
+  "git_repo_name": "spyder-{{ cookiecutter.plugin_name.lower().replace(' ', '-')}}",
+  "python_package_name": "{{ cookiecutter.git_repo_name.replace('-', '_') }}",
   "description": "Plugin for Spyder IDE.",
   "version": "0.1.0",
+  "author": "Spyder Project Contributors",
+  "email": "[email protected]",
+  "github_username": "spyder-ide",
   "create_config_page": "n",
-  "use_ciocheck": "y",
   "support_python_2": "n",
   "spyder3_compatibility": "n",
   "graphical_plugin": "y"

hooks/post_gen_project.py

@@ -25,7 +25,13 @@ def remove(filepath):
 if not create_widget:
     # Remove the widgets folder if the plugin is not graphical
     remove(os.path.join(PROJECT_DIRECTORY,
-                        '{{cookiecutter.project_name}}', 'widgets'))
+                        '{{cookiecutter.python_package_name}}', 'widgets'))
+
+
+valid_name = '{{cookiecutter.python_package_name}}'.startswith('spyder_')
+
+if not valid_name:
+    raise ValueError('Third party plugins name should start with spyder_')
 
 
 def init_git():
@@ -49,7 +55,7 @@ def init_git():
 # 2. Create empty assets directory
 
 assets_dir = os.path.join(PROJECT_DIRECTORY,
-                          '{{ cookiecutter.project_name }}',
+                          '{{ cookiecutter.python_package_name }}',
                           'assets')
 
 os.mkdir(assets_dir)

setup.cfg

@@ -1,2 +1,2 @@
 [tool:pytest]
-norecursedirs = {{\ cookiecutter.repo_name\ }}
+norecursedirs = {{\ cookiecutter.git_repo_name\ }}

tests/test_cookiecutter_generation.py

@@ -10,8 +10,8 @@ def context():
         'email': '[email protected]',
         'github_username': 'spyder-ide',
         'plugin_name': 'Demo',
-        'repo_name': 'spyder-demo',
-        'project_name': 'spyder_demo',
+        'git_repo_name': 'spyder-demo',
+        'python_package_name': 'spyder_demo',
         'description': 'Plugin for Spyder IDE.',
         'version': '0.1.0',
     }
@@ -24,8 +24,8 @@ def non_graphical():
         'email': '[email protected]',
         'github_username': 'spyder-ide',
         'plugin_name': 'Demo-nongraphic',
-        'repo_name': 'spyder-demo-nongraphic',
-        'project_name': 'spyder_demo_nongraphic',
+        'git_repo_name': 'spyder-demo-nongraphic',
+        'python_package_name': 'spyder_demo_nongraphic',
         'description': 'Plugin for Spyder IDE.',
         'version': '0.1.0',
         'graphical_plugin': 'n'
@@ -36,7 +36,7 @@ def test_default_configuration(cookies, context):
     result = cookies.bake(extra_context=context)
     assert result.exit_code == 0
     assert result.exception is None
-    assert result.project.basename == context['repo_name']
+    assert result.project.basename == context['git_repo_name']
     assert result.project.isdir()
 
     # Test creation of project files
@@ -54,7 +54,7 @@ def test_default_configuration(cookies, context):
     project_files = ['widgets', 'assets', 'demoplugin.py', '_version.py',
                      '__init__.py', 'tests']
 
-    project_dir = result.project.join(context['project_name'])
+    project_dir = result.project.join(context['python_package_name'])
     found_project_files = [f.basename for f in project_dir.listdir()]
 
     for path in project_files:
@@ -66,7 +66,7 @@ def test_non_graphical_configuration(cookies, non_graphical):
     result = cookies.bake(extra_context=non_graphical)
     assert result.exit_code == 0
     assert result.exception is None
-    assert result.project.basename == non_graphical['repo_name']
+    assert result.project.basename == non_graphical['git_repo_name']
     assert result.project.isdir()
 
     # Test creation of project files
@@ -84,7 +84,7 @@ def test_non_graphical_configuration(cookies, non_graphical):
     project_files = ['assets', 'demo-nongraphicplugin.py', '_version.py',
                      '__init__.py', 'tests']
 
-    project_dir = result.project.join(non_graphical['project_name'])
+    project_dir = result.project.join(non_graphical['python_package_name'])
     found_project_files = [f.basename for f in project_dir.listdir()]
 
     for path in project_files:

{{ cookiecutter.repo_name }}/README.rst → {{ cookiecutter.git_repo_name }}/README.rst

@@ -12,13 +12,13 @@ Using pip
 
 ::
 
-pip install {{ cookiecutter.project_name }}
+pip install {{ cookiecutter.python_package_name }}
 
 Using conda
 
 ::
 
-conda install {{ cookiecutter.project_name }} -c spyder-ide
+conda install {{ cookiecutter.python_package_name }} -c spyder-ide
 
 Usage
 -----

{{ cookiecutter.git_repo_name }}/setup.cfg

@@ -0,0 +1,8 @@
+{%- if cookiecutter.support_python_2 == 'y' -%}
+[bdist_wheel]
+universal=1
+
+{% endif -%}
+
+[tool:pytest]
+addopts =-x -v -rw --durations=10 --cov={{ cookiecutter.python_package_name }} --cov-report=term-missing

{{ cookiecutter.repo_name }}/setup.py → {{ cookiecutter.git_repo_name }}/setup.py

@@ -5,7 +5,7 @@
 # Licensed under the terms of the MIT License
 # (see LICENSE.txt for details)
 # -----------------------------------------------------------------------------
-"""Setup script for {{ cookiecutter.project_name }}."""
+"""Setup script for {{ cookiecutter.python_package_name }}."""
 
 # Standard library imports
 import ast
@@ -29,9 +29,9 @@ def get_description():
 
 
 setup(
-    name='{{ cookiecutter.repo_name }}',
+    name='{{ cookiecutter.git_repo_name }}',
     keywords=['Spyder', 'Plugin'],
-    url='https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.repo_name }}',
+    url='https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.git_repo_name }}',
     license='MIT',
     author='{{ cookiecutter.author }}',
     author_email='{{ cookiecutter.email }}',

{{ cookiecutter.repo_name }}/{{ cookiecutter.project_name }}/tests/test_plugin.py → {{ cookiecutter.git_repo_name }}/{{ cookiecutter.python_package_name }}/tests/test_plugin.py

@@ -13,7 +13,7 @@
 import pytest
 
 # Local imports
-from {{ cookiecutter.project_name }}.{{ module_name }} import {{ plugin_name }}
+from {{ cookiecutter.python_package_name }}.{{ module_name }} import {{ plugin_name }}
 
 
 {%- if cookiecutter.graphical_plugin == 'y' %}