labmacambira / aa Goto Github PK

oooOoOo[ AA ]oOoOooo
====================

What is AA? Read the file aa-what-is-aa for one way to look at it.

Installing
==========

Put aa.py on your /usr/local/bin:

    $ sudo cp aa.py /usr/local/bin/aa

Or just create a link:

    $ sudo ln -s /complete/path/to/your/aa.py /usr/local/bin/aa

Configure your nickname:

    $ aa config user.nickname <YOUR NICKNAME HERE>

And the AA-Web (the web server) URL:

    $ aa config server.url http://www.pulapirata.com/skills/aa/parser.php

Install dependencies:

    $ sudo apt-get install libnotify-bin espeak

Usage
=====

Now you can use:

    $ aa start                        ... starts your session
    $ aa post foo                     ... posts foo
    $ aa shout foo                    ... posts foo and sends message to server
    $ aa stop                         ... stops your session
    $ aa config <attribute> <value>   ... sets some attribute
    $ aa status|st                    ... checks if daemon is running
    $ aa time|ts                      ... show time and timeslot info
    $ aa viewlog                      ... shows your current log
    $ aa push                         ... pushes your log to the server

For now, just 'aa stop' will send your 'work log' to the server. You
can see your log at http://www.pulapirata.com/skills/aa (or any server configured using
aa config server.url <URL SERVER HERE>).

We suggest to shortcut aa shout to a simpler name such as 'as', since it is used
very often:

  echo 'alias as="aa shout"'  >> ~/.bashrc

Configuring
===========

Configuration attributes currently in use:

    user.nickname
    user.email
    user.tick
    server.url

Suggested Workflow
==================

A suggestion for your daily workflow on Lab Macambira:

* Look at the tickets of your GT on https://sourceforge.net/apps/trac/labmacambira
    aa tickets
    aa showticket <ticket number>
* Use AA
    aa start
    aa shout working on foo
    aa stop
    aa push
* Use '''shout''' instead of '''post''' when you are connected to the Web
* Open how many tickets your consider necessary to organize your actions
* Keep atention to your GT milestones
* Close the tickets you'll fixing
* Use the wiki a lot to report your activities: http://wiki.nosdigitais.teia.org.br/Lab_Macambira
* Use the mail list ([email protected]) and IRC (#labmacambira at irc.freenode.net)

Contributing
============

If you don't have permission as developer on the AA's SourceForge project,
please send an email asking to [email protected].

If you have permission, clone the repos:

    git clone ssh://[email protected]/gitroot/labmacambira/aa

Change USERNAME by your SourceForge username.

For more information, take a look at http://wiki.nosdigitais.teia.org.br/Manual_do_Novato.