Code location

The egg will be installed to the standard site package location.

On Linux that is usually /usr/lib/pythonX.Y/site-packages; on Windows it is C:\PythonXY\Lib\site-packages (where X is the major version, and Y is the minor version, e.g. 2.4).

Data location

You may specify where the data is stored (by default a single sqlite file). See below.

The long version

SimpleShelf requires Python version 2.4 or greater. Download that version for your operating system from this page.

Once you have installed Python, download the ez_setup.py, which will install EasyInstall, the software that will install the egg.

Then run (in a command window):

python easy_install http://rhymingpanda.com/projects/simpleshelf/simpleshelf-0.4.0-py2.4.egg

Once the code has been installed, you need to set several options in the configuration file, and create a database.

Create a data directory for simpleshelf, copy the sample-prod.cfg file from the egg's directory to the data directory, and change these values:

• Find the line sqlobject.dburi="sqlite://%(current_dir_uri)s/devdata.sqlite" and change %(current_dir_uri)s to the full path to the data directory. See the examples for the proper syntax.
• Find the line [[[access_out]]]. Add a full path to server.log in the first value (args="('server.log',)"

Create the database with this command:

tg-admin --config=/full/path/to/your/prod.cfg --egg=simpleshelf sql create

Your system is ready to run simpleshelf! The actual command is:

start-simpleshelf.py /full/path/to/your/prod.cfg

The short version

1. Install Python 2.4 or greater
2. Download ez_setup.py
3. Install ez_setup.py: python ez_setup.py
4. Install SimpleShelf: python easy_install http://rhymingpanda.com/projects/simpleshelf/simpleshelf-0.4.0-py2.4.egg
5. If installing for the first time
   • Create a directory to store your SimpleShelf files (database and configuration) - your data directory.
   • From the simpleshelf egg directory, copy the sample-prod.cfg to your data directory and rename it prod.cfg.
   • In prod.cfg:
     • Find the line sqlobject.dburi="sqlite://%(current_dir_uri)s/devdata.sqlite" and change %(current_dir_uri)s to the full path to the data directory. See the examples for the proper syntax.
     • Find the line [[[access_out]]]. Add a full path to server.log in the first value (args="('server.log',)"
   • Create a new database: tg-admin --config=/full/path/to/your/prod.cfg --egg=simpleshelf sql create
6. If upgrading an existing installation
   • Change to the existing data directory
   • TBD
7. Run SimpleShelf: start-simpleshelf.py /full/path/to/your/prod.cfg