Carp cuts down on typing by letting you store code templates (using jinja2) and then render them.
I named this project carp because this project will save me from CARP-al tunnel. Harharhar.
Yes. Terrible idea. Good programmers use libraries and inheritance and dynamic code generation and run-time message passing to shrink redundancy.
Shitty programmers use copy-paste. And only the worst programmer imaginable would ever design and use a copy-paste framework.
This project is an abomination.
Hurry back to hacker news!
You can use easy_install:
$ easy_install carp
Or you can get the source from github here:
$ git clone https://github.com/mw44118/carp.git
$ cd carp
$ python setup.py install
The first thing to do is make a directory named “carpdir” at the top of your project:
$ cd ~/src/my-awesome-project
$ mkdir carpdir
That’s where carp will store templates.
Now you can ask carp what templates are available. Since you haven’t stored any templates yet, you won’t get anything back though:
$ carp-list
no carpdir found!
$ mkdir carpdir
$ carp-list
Next, pick a file that you want to use as a template and copy it to some out-of-the-way place:
$ cp script.py /tmp/base_script.py
Now edit that copy and replace the text that you want to be passed in as a parameter, by using double-curly braces, like this:
{{project_name}}
Actually, you can use any jinja2 tricks, because the files will be run as jinja2 templates. For example, you can use a filter to make sure something comes out as lower case like this:
{{ project_name | lower }}
Once you have replaced the text that you want to use as parameters, add this template like this:
$ carp-add /tmp/base_script.py
You can get a list of required variables to pass in:
$ carp-info base_script.py
base_script.py required variables
* project_name
That tells you that you have to pass in a project_name variable when you render the base_script.py template.
And now you can render that template:
$ carp-render base_script.py --define project_name=bogus
That will write a bunch of stuff to standard output, so use redirect to put it in a file:
$ carp-render base_script.py --define project_name=bogus > bogus_script.py
You can have single-file templates, but you can also store trees of folders and files as templates too.
Imagine you have a folder proj with a bunch of stuff inside and you want it to be a template:
$ find proj
proj/
proj/setup.py
proj/src
proj/src/proj
proj/src/proj/__init__.py
You add folder templates just the same:
$ carp-add proj
And carp-info works the same:
$ carp-info proj
proj required variables
* projname
But when you render a template that is a folder, you have to give me a folder to put it in, like this:
$ carp-render proj /tmp --define projname=scratch
Now you’ll see a folder /tmp/proj with all your stuff inside:
$ find /tmp/proj
/tmp/proj
/tmp/proj/setup.py
/tmp/proj/src
/tmp/proj/src/proj
/tmp/proj/src/proj/__init__.py