UbuntuGrok

Differences between revisions 28 and 38 (spanning 10 versions)
Revision 28 as of 2008-10-26 20:51:06
Size: 3498
Editor: replaceafill
Comment:
Revision 38 as of 2009-02-05 15:36:28
Size: 1270
Editor: 158
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This documents the procedure we used to setup a Grok virtual environment for working on the
Viejo content management system. Note that as of September 29th, grokproject 0.9 and grok 0.14 work on python2.5. So the easy_install-2.4 can be omitted.
This page will document a few Grok projects that we are working on and how to set them up on Ubuntu.
[[https://edge.launchpad.net/~replaceafill|Douglas]] is trying his best to teach
[[https://edge.launchpad.net/~jelkner|me]] Grok, but I'm a slow learner so it is hard going...

jeff elkner

Here is what we have so far:

We will be installing Grok and all the supporting Python software in what is called a '''virtual environment'''. There are two good reasons for doing this:

  0. It is easiest, in the sense that the changes you will make to your system will be localized and will neither effect nor be effected by any other Python environment you have on your system.
  0. It is safest, for the same reason.

Once we have a real application we want to deploy, it will be time to leave the ease and safety of our virtual environment behind us, but for now, since we are just learning, we will remain in the warmth and comfort that our virtual environment creates.

Before you can create a virtual environment, run the following two commands from a Unix prompt:
Line 6: Line 20:
  * {{{mkdir viejo_virtualenv}}}
  * {{{cd viejo_virtualenv}}}
  * {{{virtualenv --no-site-packages virtualgrok}}}
  * {{{source virtualgrok/bin/activate}}}
  * {{{easy_install grokproject}}}
  * {{{grokproject Viejo}}}
  * {{{cd Viejo}}}
  * {{{rm -rf setup.py buildout.cfg src}}}
  * {{{bzr checkout}}} [[https://launchpad.net/~viejo-team/viejo-code/yagni|lp:~viejo-team/viejo-code/yagni]] {{{.}}} (''Note:'' don't miss the dot at the end of this command.)
  * {{{./bin/buildout}}}
  * {{{./bin/test}}}
Line 18: Line 21:
Now, we're good to go TDD. The main files and directories of our project are:
Line 20: Line 22:
  * setup.py -> Mostly to include packages required for our project to work
  * buildout.cfg -> Configuration for our instance
  * src/viejo/models.py -> Stores the '''models''' of our application. See the [[http://en.wikipedia.org/wiki/Model-view-controller|Model-view-controller]] for more
  * src/viejo/tests -> Directory to store our unit doctests (Doctests are usually written in [[http://docutils.sourceforge.net/docs/user/rst/quickref.html|reStructuredText]])
  * src/viejo/tests/models.txt -> Unit doctests for our models.py module
  * src/viejo/ftests -> Directory to store our functional doctests
  * src/viejo/ftests/viejo.txt -> Functional doctests for our application
== Projects ==
Line 28: Line 24:
For every change we do to the application we always have to run {{{Viejo/bin/test}}} to check we don't break anything. We could access bin/test from anywhere in our path. For example, if we're inside our project's ftests directory we could call ../../../bin/test and it will run all our unit and functional tests. If we only want to run a kind of tests we could call it like this:

  * bin/test -u -> It will run only unit doctests inside the src/viejo/tests directory
  * bin/test -f -> It will run only functional doctests inside the src/viejo/ftests directory

Some useful bzr commands we will need:

  * bzr co lp:~viejo-team/viejo-code/yagni . -> It will check out our yagni branch inside the current directory. Why are we not using branches? Well, check out the '''When would I want a checkout?''' section of [[http://bazaar-vcs.org/CheckoutTutorial]]. Right now, I think it's OK working like this. Remember the name of our branch? ;)
  * bzr status -> It will tell us which files have been changed or deleted, which ones are about to be added to our branch and which ones are still unknown to bzr. '''Always''' use {{{bzr status}}} before doing a check in. Maybe our local setup works, but we have to make sure launchpad get all the files we want
  * bzr add <filename> -> Makes bzr to know about our new file
  * bzr remove <filename> -> Deletes a file from our project
  * bzr revert <filename> -> Restore <filename> to be the one we checked out
  * bzr ci -m "Some descriptive message" -> Checks changes back into launchpad

Some useful documentation urls we will need:
  * http://apidoc.zope.org -> This is the Zope 3 API Documentation

Whenever we want to start the zope server to check the functionality you do:
  * bin/zopectrl fg -> this starts the server and leaves the process on foreground
  * GrokTutorial
  * [[Viejo]]

This page will document a few Grok projects that we are working on and how to set them up on Ubuntu. Douglas is trying his best to teach me Grok, but I'm a slow learner so it is hard going...

jeff elkner

Here is what we have so far:

We will be installing Grok and all the supporting Python software in what is called a virtual environment. There are two good reasons for doing this:

  1. It is easiest, in the sense that the changes you will make to your system will be localized and will neither effect nor be effected by any other Python environment you have on your system.
  2. It is safest, for the same reason.

Once we have a real application we want to deploy, it will be time to leave the ease and safety of our virtual environment behind us, but for now, since we are just learning, we will remain in the warmth and comfort that our virtual environment creates.

Before you can create a virtual environment, run the following two commands from a Unix prompt:

  • sudo apt-get install build-essential python-dev python-setuptools subversion bzr

  • sudo easy_install virtualenv

Projects

UbuntuGrok (last edited 2009-02-05 15:36:28 by 158)