Misc helper-scripts for creating and expanding Plone-Add-Ons.
Project description
Introduction
============
Yet another command-line Plone-Add-On-Generator, just the way I like it:
No dependencies, no possible conflicts, some Python-methods, that's all.
Installation
=============
pip install adi.devgen
Alternatively add `adi.devgen` as an egg to your buildout, then
the `devgen`-executable should be available in its bin-directory.
Development-versions:
pip install -e git+https://github.com/ida/adi.devgen.git#egg=adi.devgen
pip install -e git+https://github.com/ida/adi.commons.git#egg=adi.commons
Usage
=====
Type the command alone, to get a help-text, what it can do for you:
$ devgen
That'll also lists the available generator-functions, to get a function's help-text, type:
$ devgen [FUNCTION_NAME]
Examples
========
Create boilerplate for an addon, that can do nothing, but be installed in a Plonesite:
$ devgen addProfileSkel your.addon
Create it not in the directory, where you are, but somewhere else:
$ devgen addProfileSkel /some/where/else/your.addon
Register another addon as a dependency to your addon:
$ devgen addDep collective.bestaddonever your.addon
Or, first locate into your addon, then you can omit the appended path (defaults to '.'):
$ cd your.addon
$ devgen addDep collective.bestaddonever
Create an installable Plone-Addon, with a stylesheet, a javascript and a template in a skin folder:
$ devgen addSkinSkel your.addon
In contrary to browser-based resources, you won't need to empty the browser's cache on a reload, after changing your stylesheet or javascript.
Create an installable Plone-Addon, with a stylesheet and a javascript in a browser's resource-folder.
$ devgen addBrowserSkel your.addon
Add docs-folder and read defaults for setup.py of a config:
$ devgen addMetaSkel
If a file '~/.buildout/devgen.cfg' is present, values will be read of it and inserted to setup.py. Its format is expected to be like:
author=Arbi Trary
author_email=arbi@tra.ry
url=https://github.com/arbitrary/your.addon
TODO
====
- Regard more than one dotted namespace for addon.
- Split functions into smaller reusable chunks.
- Possibly transfer:
https://github.com/ida/skriptz/blob/master/plone/Dexterity/addField.py
Changelog
=========
0.8 (151002)
------------
- Generate missing browser-slug in config.
- Change docs from MD-format to RST, as pypi requires.
- Add addCss() and addJs().
0.7 (150926)
------------
- Fix missing import and typo in setup.py-generation, which broke addons-installs.
0.6 (150923)
------------
- Update README, improve installPlone().
0.5 (150921)
------------
- Fix imports, better hlp-msgs, improve installPlone().
0.4 (150920)
------------
- Update README
0.3 (150920)
------------
- Fix changed import-paths.
0.2 (150920)
------------
- Add adi.commons as dependency.
0.1 (150920)
------------
- Initial release
============
Yet another command-line Plone-Add-On-Generator, just the way I like it:
No dependencies, no possible conflicts, some Python-methods, that's all.
Installation
=============
pip install adi.devgen
Alternatively add `adi.devgen` as an egg to your buildout, then
the `devgen`-executable should be available in its bin-directory.
Development-versions:
pip install -e git+https://github.com/ida/adi.devgen.git#egg=adi.devgen
pip install -e git+https://github.com/ida/adi.commons.git#egg=adi.commons
Usage
=====
Type the command alone, to get a help-text, what it can do for you:
$ devgen
That'll also lists the available generator-functions, to get a function's help-text, type:
$ devgen [FUNCTION_NAME]
Examples
========
Create boilerplate for an addon, that can do nothing, but be installed in a Plonesite:
$ devgen addProfileSkel your.addon
Create it not in the directory, where you are, but somewhere else:
$ devgen addProfileSkel /some/where/else/your.addon
Register another addon as a dependency to your addon:
$ devgen addDep collective.bestaddonever your.addon
Or, first locate into your addon, then you can omit the appended path (defaults to '.'):
$ cd your.addon
$ devgen addDep collective.bestaddonever
Create an installable Plone-Addon, with a stylesheet, a javascript and a template in a skin folder:
$ devgen addSkinSkel your.addon
In contrary to browser-based resources, you won't need to empty the browser's cache on a reload, after changing your stylesheet or javascript.
Create an installable Plone-Addon, with a stylesheet and a javascript in a browser's resource-folder.
$ devgen addBrowserSkel your.addon
Add docs-folder and read defaults for setup.py of a config:
$ devgen addMetaSkel
If a file '~/.buildout/devgen.cfg' is present, values will be read of it and inserted to setup.py. Its format is expected to be like:
author=Arbi Trary
author_email=arbi@tra.ry
url=https://github.com/arbitrary/your.addon
TODO
====
- Regard more than one dotted namespace for addon.
- Split functions into smaller reusable chunks.
- Possibly transfer:
https://github.com/ida/skriptz/blob/master/plone/Dexterity/addField.py
Changelog
=========
0.8 (151002)
------------
- Generate missing browser-slug in config.
- Change docs from MD-format to RST, as pypi requires.
- Add addCss() and addJs().
0.7 (150926)
------------
- Fix missing import and typo in setup.py-generation, which broke addons-installs.
0.6 (150923)
------------
- Update README, improve installPlone().
0.5 (150921)
------------
- Fix imports, better hlp-msgs, improve installPlone().
0.4 (150920)
------------
- Update README
0.3 (150920)
------------
- Fix changed import-paths.
0.2 (150920)
------------
- Add adi.commons as dependency.
0.1 (150920)
------------
- Initial release
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
adi.devgen-0.8.tar.gz
(20.0 kB
view hashes)
Built Distribution
adi.devgen-0.8-py2.7.egg
(29.8 kB
view hashes)