[ckan-changes] [ckan/ckan] 8a493b: [#4799] Update extension tutorial for cookiecutter

Sergey noreply at github.com
Thu Oct 10 13:08:51 UTC 2019 

  Branch: refs/heads/master
  Home:   https://github.com/ckan/ckan
  Commit: 8a493bfc44a8bdb59a882190535a2e193642bc30
      https://github.com/ckan/ckan/commit/8a493bfc44a8bdb59a882190535a2e193642bc30
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-11 (Wed, 11 Sep 2019)

  Changed paths:
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  [#4799] Update extension tutorial for cookiecutter

Replace mentions of `paster create` with `cookiecutter`. Not sure the
final location for the cookiecutter templates, the instructions for how
to get it has a placeholder "https://github.com/<user>/<reop>.git"


  Commit: 4b90d441747673c3d64f2357dfc8763323846cb7
      https://github.com/ckan/ckan/commit/4b90d441747673c3d64f2357dfc8763323846cb7
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-11 (Wed, 11 Sep 2019)

  Changed paths:
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  [#4799] Fix typo in .rst syntax


  Commit: a1bc91a4bd44731659886b67e98aec14238be4ec
      https://github.com/ckan/ckan/commit/a1bc91a4bd44731659886b67e98aec14238be4ec
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-23 (Mon, 23 Sep 2019)

  Changed paths:
    A contrib/cookiecutter/ckan_extension/.travis.yml
    A contrib/cookiecutter/ckan_extension/LICENSE
    A contrib/cookiecutter/ckan_extension/README.md
    A contrib/cookiecutter/ckan_extension/cookiecutter.json
    A contrib/cookiecutter/ckan_extension/hooks/post_gen_project.py
    A contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.coveragerc
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.travis.yml
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/LICENSE
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/MANIFEST.in
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/README.rst
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/bin/travis-build.bash
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/bin/travis-run.sh
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/fanstatic/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/i18n/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/plugin.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/public/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/templates/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/tests/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/tests/test_plugin.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/dev-requirements.txt
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/requirements.txt
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.cfg
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.py
    M dev-requirements.txt
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Add Cookiecutter to Core

Small update to tutorial


  Commit: d24c9f7c92f40a64779508198586a16ed181e555
      https://github.com/ckan/ckan/commit/d24c9f7c92f40a64779508198586a16ed181e555
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Update documentation to use local path to template


  Commit: 5dfa301bcb78301fb2996ed57de2a74880673cae
      https://github.com/ckan/ckan/commit/5dfa301bcb78301fb2996ed57de2a74880673cae
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    M ckan/cli/cli.py
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Start CLI for ckan extension creation


  Commit: a03f6b1eb06eb554fe99f9e4319d15bc82f89bab
      https://github.com/ckan/ckan/commit/a03f6b1eb06eb554fe99f9e4319d15bc82f89bab
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    A ckan/cli/generate.py
    M contrib/cookiecutter/ckan_extension/hooks/post_gen_project.py
    M contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py
    M contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/plugin.py
    M contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.py
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Finish CLI for extension generation

This commit also has some clean up for a few errors caught by Travis and
Circle CI


  Commit: 1f473288ed66208929ffe4b6308702290e5bc730
      https://github.com/ckan/ckan/commit/1f473288ed66208929ffe4b6308702290e5bc730
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    M ckan/cli/generate.py
    M ckan/tests/legacy/test_coding_standards.py
    M ckan/tests/test_coding_standards.py
    M contrib/cookiecutter/ckan_extension/hooks/post_gen_project.py
    M contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py
    M contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.py

  Log Message:
  -----------
  Cleanup for tests


  Commit: 259ba2aa3118ed9ea53061c0e1a38c80a6a4085d
      https://github.com/ckan/ckan/commit/259ba2aa3118ed9ea53061c0e1a38c80a6a4085d
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    M ckan/cli/generate.py
    M ckan/tests/legacy/test_coding_standards.py
    M contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py

  Log Message:
  -----------
  Cleanup, little bit more, for tests


  Commit: 963bc7846658307d12fcdb791f22683758429bec
      https://github.com/ckan/ckan/commit/963bc7846658307d12fcdb791f22683758429bec
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-27 (Fri, 27 Sep 2019)

  Changed paths:
    M ckan/tests/test_coding_standards.py

  Log Message:
  -----------
  Fix path


  Commit: 9e23b1022385f2c5a76ed70e6c2060b582c1c2d3
      https://github.com/ckan/ckan/commit/9e23b1022385f2c5a76ed70e6c2060b582c1c2d3
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M ckan/cli/generate.py
    M ckan/tests/legacy/test_coding_standards.py

  Log Message:
  -----------
  Correction for string literal prefix test


  Commit: 865dcc44eec52584748509d4dd06289342a1bc20
      https://github.com/ckan/ckan/commit/865dcc44eec52584748509d4dd06289342a1bc20
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M ckan/cli/generate.py
    M ckan/tests/legacy/test_coding_standards.py

  Log Message:
  -----------
  Missed one


  Commit: d4ae4104b2d9419e27016f4f61215b36df3f5f57
      https://github.com/ckan/ckan/commit/d4ae4104b2d9419e27016f4f61215b36df3f5f57
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M ckan/cli/generate.py

  Log Message:
  -----------
  Break up lines > 79


  Commit: 2289c596c78ccd5d85590575c1555b0c0f719516
      https://github.com/ckan/ckan/commit/2289c596c78ccd5d85590575c1555b0c0f719516
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M .travis.yml

  Log Message:
  -----------
  Set Travis CI to ignore /cookiecutter/

Because of the `cookiecutter` works some of the files can't conform to
pep8.


  Commit: 809063e7731bdd2514c28f1b1e930e81fd3ef249
      https://github.com/ckan/ckan/commit/809063e7731bdd2514c28f1b1e930e81fd3ef249
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M .travis.yml

  Log Message:
  -----------
  Correct path for exclusion


  Commit: e8ca9b2cae12ae79d20104755881f95442764fce
      https://github.com/ckan/ckan/commit/e8ca9b2cae12ae79d20104755881f95442764fce
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-09-30 (Mon, 30 Sep 2019)

  Changed paths:
    M .travis.yml

  Log Message:
  -----------
  Fix exclusion

For real this time?


  Commit: db21000d0a14e84f2b06eb6f7a4c22bc25f68221
      https://github.com/ckan/ckan/commit/db21000d0a14e84f2b06eb6f7a4c22bc25f68221
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-10-09 (Wed, 09 Oct 2019)

  Changed paths:
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Add instructions for using the CLI `ckan generate extension`


  Commit: 5d256cfe1ccff2e30b8c029f9a99ca93d4d364e3
      https://github.com/ckan/ckan/commit/5d256cfe1ccff2e30b8c029f9a99ca93d4d364e3
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-10-09 (Wed, 09 Oct 2019)

  Changed paths:
    M ckan/cli/generate.py

  Log Message:
  -----------
  Make generate.py behave more like `cookiecutter`

Previously, the user was required to give the -n flag for the
extension's name for the command `ckan generate extension`. This moves
the name to prompt and makes the behavior more closesly match just using
`cookiecutter`.


  Commit: 2f2db1f3165b6e5c8953e29d1f5002e4fa65eea5
      https://github.com/ckan/ckan/commit/2f2db1f3165b6e5c8953e29d1f5002e4fa65eea5
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-10-09 (Wed, 09 Oct 2019)

  Changed paths:
    M ckan/cli/generate.py

  Log Message:
  -----------
  generate.py checks extension name

There is a pre-gen hook in cookiecutter that checks that the the
extension's name begins with `ckanext-`. This works fine when using
`cookiecutter`, but when using the CLI there's big, ugly traceback. This
update avoids that.


  Commit: 2e6e3c206a889a0652f154f4017cfdd78ececa3f
      https://github.com/ckan/ckan/commit/2e6e3c206a889a0652f154f4017cfdd78ececa3f
  Author: f-osorio <f.osorio at zbw.eu>
  Date:   2019-10-09 (Wed, 09 Oct 2019)

  Changed paths:
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Fix topic block in documentation


  Commit: f717999a1a4e63ecc192cb4dfe5a7506b7c8cff0
      https://github.com/ckan/ckan/commit/f717999a1a4e63ecc192cb4dfe5a7506b7c8cff0
  Author: Sergey <tonnydexter at gmail.com>
  Date:   2019-10-10 (Thu, 10 Oct 2019)

  Changed paths:
    M .travis.yml
    M ckan/cli/cli.py
    A ckan/cli/generate.py
    M ckan/tests/legacy/test_coding_standards.py
    M ckan/tests/test_coding_standards.py
    A contrib/cookiecutter/ckan_extension/.travis.yml
    A contrib/cookiecutter/ckan_extension/LICENSE
    A contrib/cookiecutter/ckan_extension/README.md
    A contrib/cookiecutter/ckan_extension/cookiecutter.json
    A contrib/cookiecutter/ckan_extension/hooks/post_gen_project.py
    A contrib/cookiecutter/ckan_extension/hooks/pre_gen_project.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.coveragerc
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/.travis.yml
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/LICENSE
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/MANIFEST.in
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/README.rst
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/bin/travis-build.bash
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/bin/travis-run.sh
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/fanstatic/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/i18n/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/plugin.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/public/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/templates/.gitignore
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/tests/__init__.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/ckanext/{{cookiecutter.project_shortname}}/tests/test_plugin.py
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/dev-requirements.txt
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/requirements.txt
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.cfg
    A contrib/cookiecutter/ckan_extension/{{cookiecutter.project}}/setup.py
    M dev-requirements.txt
    M doc/extensions/tutorial.rst

  Log Message:
  -----------
  Merge pull request #4982 from f-osorio/4799-extension-template-documentation

4799 extension template documentation


Compare: https://github.com/ckan/ckan/compare/42596a014a71...f717999a1a4e

More information about the ckan-changes mailing list