Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extension descriptions for easy installation #113

Open
rossjones opened this issue Dec 9, 2014 · 2 comments
Open

Extension descriptions for easy installation #113

rossjones opened this issue Dec 9, 2014 · 2 comments

Comments

@rossjones
Copy link
Contributor

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.

@adamamyl
Copy link

I like this idea. It would be useful for deployment/management systems, I think, too.

Bonus points would be if the json file could also be used to generate human-readable documentation.

@waldoj
Copy link

waldoj commented Dec 10, 2014

👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants