• Source Code

Accessing the code

For development, the source code is available via Baz or GNU Arch. To register with the official repository, proceed as follows (possibly replacing baz with tla). This needs to be done once, until a new archive is started, usually once a year.

  baz register-archive ftp://arch.pybliographer.org/archives/2007

To get a branch, say pyblio-core--devel--1.3, run:

  baz get gobry@pybliographer.org--2007/pyblio-core--devel--1.3

Baz makes it possible to create a Private branch, so that your changes can be versioned and merged from and to the official archive.

Code layout

This only mentions the 1.3 branch, as it is where new developments should go.

Below are the dependencies between the branches and their requirements.

Getting started

pyblio-core

pyblio-core behaves as a standard python library, but uses setuptools for its installation. This makes it possible to use the library in so-called develop mode, where the installed version points to the version in your working repository, making it unnecessary to perform an installation every time you modify the code. Highly recommended

To use develop mode, run:

  python setup.py develop

Once you have downloaded the code, you'll find documentation in the doc/ directory. The doc/examples/ is a good place to start looking at the code.

The reference manual is generated from the source code thanks to epydoc.

pyblio (user interface)

Once you have the code, run:

  aclocal
  automake -a
  autoconf

...and then you are in the same situation as with a released archive. You need to run:

  configure --prefix=...
  make

It is possible to develop from within the source directory without installing pyblio after each modification. The only exception so far is for the Glade files (in the glade/ directory) which are read from their installation directory. It is therefore advised to to at least one complete installation of your working copy.

Once it is done, you can start pyblio from the top level directory by running:

  ./scripts/pybliographic

An incomplete API documentation can be extracted from the source code. Go to the doc/ directory and run:

  make doc

Coding conventions

We're moving the code slowly to PEP8. The module names are still using mixed cases though.