willianpaixao / farinha

A snippet's management tool for command line written in Python using Django framework.

Farinha

Now you can store pieces of code or text in general for daily tasks. Very handy, Farinha will make you more productive.

Installation

I strongly recommend to use farinha under a portable and virtual environment, like Virtualenv. After activate your environment, install the dependences:

$ pip install django
$ pip install fabric

Don't forget to initialize your SQLite database, as in any Django project:

python manage.py migrate

Basic usage

By now, you haven't install farinha as a Python module, the commands aren't in your PATH yet. But you can run them like this:

$ python manage.py ls
$ python manage.py cat 1
$ python manage.py echo 1

Basic commands

add a new snippet

Creates a new snippet with the given title.

Examples

$ python manage.py add bash-profundo.sh
$ python manage.py add ReiDoCamarote.java --body=src/ReiDoCamarote.java

List all store snippets

$ python manage.py ls
1   bash-profundo.sh
2   ReiDoCamarote.java

Print a given snippet

$ python manage.py echo 1
$ python manage.py echo 2

Delete a given snippet

$ python manage.py rm 1 2

farinha's Issues

$EDITOR support

The editor for writing and modifying snippets should be flexible and the user's choice.

So, farinha must look up for the $EDITOR environment variable and call it.

add search for a filename

When creating a new snippet, add should search if title is a valid file, if so, add its content to the snippet entry.

Shell script support

sh function will run a snippet, given an ID, as it is Shell script.

REST API

In order to export your snippets over the network, farinha needs an API.

For now, the plan is a read-only request to share your database.
Maybe the command line interface should also get it's snippets from the API.

I'll study and plan the best approach.

Decent README.

A good, complete and pretty README.md must to be written.

Gist integration

The snippets should be sent to Github's Gist, through Gist API.

The internal database only stores the Gist's ID for further recover.

Provide a default header and footer

Dude, I think is a good idea your farinha provide a default header and footer to reduce a number of parameters at each execution.
I suggest a IF test for a first execution, and one initial setup to run a syncdb/migrate and set a header a footer.