ckan / ckan/ideas

Extension descriptions for easy installation

Open
#113 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
39
Forks
1
PR merge metrics
No merged PRs in 30d

Description

It'd be really neat if extensions on github (and elsewhere) contained something similar to node's package.json for easy installation.

I envisage this json file would describe:
- Required config options, with defaults which would be added to the .ini
- Post-installation steps, for those extensions that require DB tables (e.g. paster taxonomy init)
- Names of plugins to be added to the ckan.ini file.
- Versions of CKAN that the extension has been tested against.
- Commands to be run to cleanup the extension, remove tables etc.
- Instructions to CKAN on where migrations are held.
- Links to the repo, documentation etc.

Along with requirements in the setup.py this could make the installation of extensions much more straightforward.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names setup.py, CKAN's .ini files, and extension install and cleanup steps, but no source files or tests. Start by mapping how CKAN currently discovers extensions and applies configuration and migrations; done would require an agreed metadata format, installation lifecycle, and concrete implementation tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.