standup is an app to log daily status updates. It is currently in super early active development, check back later.
We developed it with the following priorities:
- Let's the team, stake holders and everyone else see status for team members across projects.
- Let's us do that asynchronously. Conference calls were getting difficult to schedule because of the range of timezones we're in.
- Let's us see who's blocked on what---then scrummasters can go through and work to unblock people.
To setup a local dev environment for hacking:
- Create and activate a new virtual environment.
Clone the repo:
$ git clone git://github.com/rlr/standup.git $ cd standup
Install required dependencies:
$ pip install -r requirements.txt
Configure:
$ cp ./standup/local_settings.py-dist ./standup/local_settings.py $ vim ./standup/local_settings.py
Enable and run migrations:
$ ./standup/migrations.py version_control $ ./standup/migrations.py upgrade
Run the app:
$ python standup/app.py
Oh, but wait--what can you do with it? Well, for testing purposes, you can use the included scripts/standup-cmd
which is a command-line tool you can use to create statuses.
Example:
$ ./scripts/standup-cmd localhost:5000 ou812 willkg sumo "hi!"
(Assumes your api_key is set to ou812.)
To run migrations use:
$ ./standup/migrations.py upgrade
There's a standup/local_settings.py-dist
template which you can copy to standup/local_settings.py
to start you off.
These are things you can set in standup/local_settings.py
:
- SITE_URL
The url for your site.
For example, if you're running on your local machine, it would be:
SITE_URL = 'http://localhost:5000'
No default. You must set this.
- SESSION_SECRET
Secret string used for creating session variables. This can be any string.
For example:
SESSION_SECRET = '1234'
No default. You must set this.
- API_KEY
The key used for using the API. You use this for the standup-irc bot as well as the standup-cli.
Defaults to something ridiculous.
- DEBUG
Either
True
orFalse
. Determines whether it prints lots of stuff to the console and whether errors get a debugging-friendly error page.Defaults to
False
.
These are things you can set in the environment when you launch standup:
- DATABASE_URL
The uri to use for the database.
Defaults to
sqlite:///standup_app.db
.
We use nose for testing. To run the tests, do:
$ nosetests