Add Cookiecutter to Core

Small update to tutorial

Author: f-osorio

contrib/cookiecutter/ckan_extension/.travis.yml

@@ -0,0 +1,3 @@
+language: python
+install: pip install flake8
+script: flake8 . --exit-zero

contrib/cookiecutter/ckan_extension/LICENSE

@@ -0,0 +1,33 @@
+# CKAN Extension Template
+
+[Cookiecutter](https://github.com/audreyr/cookiecutter) for creating a [CKAN](https://github.com/ckan/ckan) extension skeleton.
+
+## Getting Started
+
+Install Cookiecutter:
+```sh
+$pip install cookiecutter
+```
+
+Generate the skeleton:
+```sh
+$ cookiecutter https://github.com/f-osorio/cookiecutter-ckan-extension.git
+```
+
+Cookiecutter will prompt you for the following information to generate the skeleton:
+```no-highlight
+project: name of the project - MUST begin with "ckanext-"
+keywords: associated with the project
+description: of the project
+author: of the project
+author_email: 
+github_user_name: GitHub user or organization name
+```
+
+Additionally, it will display the following which should not be changed:
+```no-highlight
+project_shortname
+plugin_class_name 
+```
+
+Consult [CKAN documentation](https://docs.ckan.org/en/latest/extensions/tutorial.html) for creating an extension.

contrib/cookiecutter/ckan_extension/README.md

@@ -0,0 +1,11 @@
+{
+    "project": "Project's name (must begin with 'ckanext-')",
+    "keywords": "A space separated list of keywords",
+    "description": "",
+    "author": "",
+    "author_email": "",
+    "github_user_name": "Github user or organization name",
+    "project_shortname": "{{ cookiecutter.project[8:].lower().replace('-','_') }}",
+    "plugin_class_name": "{{ cookiecutter.project_shortname.title().replace('_','') }}Plugin",
+    "_source": "local"
+}

contrib/cookiecutter/ckan_extension/cookiecutter.json

@@ -0,0 +1,69 @@
+import os
+import json
+import jinja2
+import cookiecutter.find as find
+import cookiecutter.generate as gen
+from cookiecutter.config import DEFAULT_CONFIG as config
+from cookiecutter.environment import StrictEnvironment
+from cookiecutter.exceptions import NonTemplatedInputDirException
+from cookiecutter.main import cookiecutter as c
+
+
+def recut():
+    """
+        Recreate setup.py so that we can edit keywords
+    """
+    # template location
+    try:
+        # cutting cookie from directory with template
+        temp_dir = find.find_template('..')
+    except NonTemplatedInputDirException as e:
+        # template coming from Github
+        # Hooks are passed through jinja2. raw will
+        # Make sure `cookiecutter.project` isn't replaced
+        {% raw %}
+        temp_dir = os.path.join(config['cookiecutters_dir'],
+                                'cookiecutter-ckan-extension',
+                                '{{cookiecutter.project}}')
+        {% endraw %}
+
+    # Location for resulting file
+    destination = os.getcwd()
+    # name of template
+    setup_template = 'setup.py'
+
+    # get context
+    context = {{ cookiecutter | jsonify }}
+
+    # Process keywords
+    keywords = context['keywords'].strip().split()
+    keywords = [keyword for keyword in keywords
+                if keyword not in ('ckan', 'CKAN', 'A','space',
+                                   'seperated','list','of','keywords')]
+    keywords.insert(0, 'CKAN')
+    keywords = u' '.join(keywords)
+    context['keywords'] = keywords
+
+    # Double check 'project_shortname' and 'plugin_class_name'
+    short_name = context['project'][8:].replace('-','_')
+    if context['project_shortname'] != short_name:
+        context['project_shortname'] = short_name
+
+    plugin_class_name = '{}Plugin'.format(context['project_shortname']\
+                        .title().replace('_',''))
+    if context['plugin_class_name'] != plugin_class_name:
+        context['plugin_class_name'] = plugin_class_name
+
+    # Recut cookie
+    env = StrictEnvironment()
+    env.loader = jinja2.FileSystemLoader(temp_dir)
+    gen.generate_file(project_dir=destination,
+                      infile=setup_template,
+                      context={'cookiecutter': context},
+                      env=env)
+
+
+if __name__ == '__main__':
+    context = {{ cookiecutter | jsonify }}
+    if context['_source'] == 'local':
+        recut()

contrib/cookiecutter/ckan_extension/hooks/post_gen_project.py

@@ -0,0 +1,14 @@
+import sys
+
+
+def validate_project_name():
+    # Check that project name begins with 'ckanext-'
+    project_name = "{{ cookiecutter.project }}"
+    if not project_name.startswith('ckanext-'):
+        print("\nERROR: Project name must start with 'ckanext-' > {}" \
+            .format(project_name))
+        sys.exit(1)
+
+
+if __name__ == '__main__':
+    validate_project_name()

contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py

@@ -0,0 +1,5 @@
+[report]
+omit =
+    */site-packages/*
+    */python?.?/*
+    ckan/*

contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.coveragerc

@@ -0,0 +1,42 @@
+.ropeproject
+node_modules
+bower_components
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+sdist/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Sphinx documentation
+docs/_build/

contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.gitignore

@@ -0,0 +1,44 @@
+language: python
+sudo: required
+
+# use an older trusty image, because the newer images cause build errors with
+# psycopg2 that comes with CKAN<2.8:
+#   "Error: could not determine PostgreSQL version from '10.1'"
+# see https://github.com/travis-ci/travis-ci/issues/8897
+dist: trusty
+group: deprecated-2017Q4
+
+# matrix
+python:
+  - 2.7
+env:
+  - CKANVERSION=master
+  - CKANVERSION=2.7
+  - CKANVERSION=2.8
+
+# tests
+services:
+  - postgresql
+  - redis-server
+install:
+  - bash bin/travis-build.bash
+  - pip install coveralls
+script: sh bin/travis-run.sh
+after_success:
+  - coveralls
+
+# additional jobs
+matrix:
+  include:
+    - name: "Flake8 on Python 3.7"
+      dist: xenial    # required for Python 3.7
+      cache: pip
+      install: pip install flake8
+      script:
+        - flake8 --version
+        - flake8 . --count --max-complexity=10 --max-line-length=127 --statistics --exclude ckan,{{ cookiecutter.project }}
+      python: 3.7
+      # overwrite matrix
+      env:
+        - FLAKE8=true
+        - CKANVERSION=master