Skip to content

Commit

Permalink
#3: Added sphinx documentation for index.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
Bystroushaak committed Oct 30, 2014
1 parent 2a3ddb4 commit 7f14052
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
edeposit.amqp.ltp
=================

This project provides AMQP bindings for LTP (Long Time Preservation) system
used in Czech National Library.

API
---


AMQP connection
---------------
AMQP communication is handled by the
`edeposit.amqp <http://edeposit-amqp.readthedocs.org>`_ module, specifically by
the ``edeposit_amqp_ltp.py`` script.

Source code
-----------
This project is released as opensource (GPL) and source codes can be found at
GitHub:

- https://github.com/edeposit/edeposit.amqp.ltp

Installation
++++++++++++
Module is hosted at `PYPI <https://pypi.python.org/pypi/edeposit.amqp.ltp>`_,
and can be easily installed using
`PIP <http://en.wikipedia.org/wiki/Pip_%28package_manager%29>`_::

sudo pip install edeposit.amqp.ltp

Testing
-------
Almost every feature of the project is tested in unit/integration tests. You
can run this tests using provided ``run_tests.sh`` script, which can be found
in the root of the project.

Requirements
++++++++++++
This script expects that pytest_ is installed. In case you don't have it yet,
it can be easily installed using following command::

pip install --user pytest

or for all users::

sudo pip install pytest

.. _pytest: http://pytest.org/

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

0 comments on commit 7f14052

Please sign in to comment.