adi.devgen 0.3

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.


Goals
=====

Be as generic as possible, e.g. `addDep` registers a dependencie's name in an existing addon, assuming you are located *somewhere* in your addon, it's:

$ devgen addDep collective.bestaddonever

But, you can also append a path ending with your addon-name, then this command will create the addon also on the fly, if it doesn't exist already:

$ devgen addDep collective.bestaddonever my.addon


Be able to specify the location-path where the command should be executed, so I do not have to change directories, or switch to other (screen-)windows all the time, I'm lazy. Incredibly lazy:

$ devgen addDep collective.bestaddonever /over/the/rainbow/my.addon


Put the documentation into the doc-strings of the functions. Function's are building up upon another, so one can learn developing step-by-step, starting with the minimal base-skel.


Installation
=============

With lovely pip, as easy as:

$ pip install -e git+https://github.com/ida/adi.devgen.git#egg=adi.devgen


If you haven't installed pip yet, do it. For Ubuntu that is:

$ sudo apt-get install python-pip -y


Or for Fedora:

$ sudo yum install python-pip -y


Alternatively, you can also clone this repo and add it to buildout as a development-egg, that'll give you the executable in the instance's bin-directory:

$ cd path/to/instance

$ ./bin/devgen


Usage
=====

Type the command alone, to get a help-text, what it can do for you:

$ devgen


That also lists the available 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 your.addon /some/where/else


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:

$ 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.3 (150920)
------------

- Fix changed import-paths.


0.2 (150920)
------------

- Add adi.commons as dependency.


0.1 (150920)
------------

- Initial release