Developing Yith Library Server¶

Installing in development mode¶

Installing Yith Library Server in development mode is very similar to the regular installation describe in the Installing Yith Library Server section. The only difference is about the installation of Yith Library Server in the Virtual Python Environment.

In the regular installation you perform these commands:

$ cd env
$ bin/easy_install yith-library-server

In development mode you execute these commands instead:

$ cd env
$ git clone git://github.com/Yaco-Sistemas/yith-library-server.git
$ cd yith-library-server
$ ../bin/python setup.py develop

In order to perform development tasks like running the tests or building the documentation it is recommended to activate the Virtual Python Environment. This way the Python interpreter used will always be taken from the Virtual Python Environment.

To activate the Virtual Python Environment, execute this command:

$ cd env
$ source bin/activate
$ cd yith-library-server

Running the tests¶

In order to run the tests you should install extra packages such as nose and coverage. Fortunately this is easily achieved with this command:

(env)$ python setup.py testing

Now running Yith Library Server tests is as easy as it could be:

(env)$ python setup.py test

You can also get the current test coverage with this command:

(env)$ python setup.py nosetests

Generating the documentation¶

Yith Library Server uses Sphinx for its documentation. The document files are inside the docs directory.

If you want to generate them from the sources you need to install the required packages:

(env)$ python setup.py docs

Now you can generate the documentation using the provided Makefile

(env)$ cd docs
(env)$ make html

And the result will be copied into the docs/build/html directory where you can point your favourite browser and enjoy the reading.

There are many more different output formats available for the documentation. Try typing make help to get a glimpse at them.