Blog

New Template for CKAN Extensions

  • Sean Hammond
  • 21 Nov 2014
We've just merged a new template for CKAN extensions. Whenever you create a new CKAN extension using the paster --plugin=ckan create -t ckanext ... command (as documented in the writing extensions tutorial) it'll now use the new template, which gives you:
  • PyPI integration - setup.py and MANIFEST.in files are automatically generated for your extension, ready for publishing to PyPI
  • A tests directory including stub tests for you to get started writing tests for your extension
  • Travis CI integration - automatically run your tests in a clean environment each time you push a new commit to GitHub. A .travis.yml file and build and run scripts are automatically generated for your extension, you still need to log in to Travis and click the switch to turn on Travis for your extension though.
  • Coveralls.io integration - track the code coverage of your tests. A .coveragerc file is automatically generated for your extension. Again, you still need to login to Coveralls and turn it on.
  • A .gitignore file
  • A LICENSE file (uses the GNU AGPL by default)
  • A reStructuredText README file with a skeleton documentation structure including generated installation and configuration instructions, how to run the tests, etc
  • Travis, Coveralls and pypip.in README badges! Show the world that you have continuous integration, good test coverage, PyPI downloads, and your extension's supported Python version, development status and license.
Screenshot from 2014-11-21 16:26:14 For an example of an extension built using this template, look at ckanext-deadoralive. What we're trying to do with this new template is:
  1. Save ourselves time, by not having to manually create all of this boilerplate every time we roll a new CKAN extension
  2. Help improve the quality of CKAN extensions by encouraging developers to write good tests and documentation, and to use services PyPI, Travis and Coveralls
More to come. If you have any ideas for things to add to the CKAN extension template, let us know on ckan-dev
More posts
28-DCAT-01
In Category on 11 Oct 2024

Enhancing DCAT support in CKAN (DCAT-AP v3, scheming integration, and more)

A review of the recent developments in CKAN's DCAT support, and how you can get involved

27-Table designer-01
In Category on 23 Sep 2024

Taming Dynamic Data with Table Designer

CKAN 2.11 introduces Table Designer: form builder and enforced validation for your data

Connect with CKAN