Extension Development Tools


Extension Basics

Title
Development Tools
Name
ckanext-dev
Type
Public extension
Description
CKAN extension that provides various development tools including an IPython shell and PyCharm remote debugger integration.
CKAN versions
Download-Url (zip)
Last commit
6 years ago (2019-11-27 11:13:51)
Url to repo
Category
Specialized Tools


Background Infos

Description (long)
Show details

ckanext-dev

This extension is no longer maintained. Archived on Nov 27, 2019.

CKAN extension that provides various development tools:

  • An IPython shell, run within the CKAN environment, started as a paster script
  • A configuration option to start PyCharm remote debugger session

Setup

To enable the remote debugger session, you need:

  1. Install the pycharm-debug.egg package on the remote machine (this file is part of the PyCharm distribution, see http://www.jetbrains.com/pycharm/webhelp/remote-debugging.html)

  2. Add the line ‘debug.remote = True’ to your configuration file (this is independent from CKAN’s debug setting; both can be enabled or disabled separately)

  3. Setup a Remote Debugger within PyCharm, using port 8888 (or as defined by debug.host.port)

You may optionally define:

  • debug.remote.host.ip for the host IP (defaults to 10.0.2.2 which is the default host IP when using Vagrant)
  • debug.remote.host.port for the host port (defaults to 8888; it needs to match the setting in PyCharm)
  • debug.remote.stdout_to_server to send stdout to the debugging host (defaults to True)
  • debug.remote.stderr_to_server to send stderr to the debugging host (defaults to True)
  • debug.remote.suspend defines whether the debugger should break as soon as it is started (defaults to False)

Usage

To use the paster launched shell do:

paster --plugin=ckanext-dev shell -c <path to your config file>
Version
Version release date
(not set)
Contact name
Natural History Museum
Contakt email
(not set)
Contact Url
(not set)


Installation Guide

Configuration hints

ARCHIVED: No longer maintained since Nov 2019. Requires pycharm-debug.egg for remote debugging. Uses paster commands (pre-CKAN 2.9).

Plugins to configure (ckan.ini)
dev
CKAN Settings (ckan.ini)
# debug.remote = True
# debug.remote.host.ip = 10.0.2.2
# debug.remote.host.port = 8888
# debug.remote.stdout_to_server = True
# debug.remote.stderr_to_server = True
# debug.remote.suspend = False
DB migration to be executed
(not set)
<< back to Extensions