.. -*- Mode: rst -*-

.. image:: https://badge.fury.io/py/PyValentina.svg
	   :target: https://badge.fury.io/py/PyValentina

.. image:: https://img.shields.io/pypi/dm/PyValentina.svg
	   :target: https://pypi.python.org/pypi/PyValentina

.. image:: https://img.shields.io/pypi/status/PyValentina.svg
	   :target: https://pypi.python.org/pypi/PyValentina

.. image:: https://img.shields.io/pypi/pyversions/PyValentina.svg
	   :target: https://pypi.python.org/pypi/PyValentina

.. image:: https://img.shields.io/pypi/l/PyValentina.svg
	   :target: https://raw.githubusercontent.com/FabriceSalvaire/PyValentina/master/LICENSE.txt

.. -*- Mode: rst -*-

..
   |PyValentinaUrl|
   |PyValentinaHomePage|_
   |PyValentinaDoc|_
   |PyValentina@github|_
   |PyValentina@readthedocs|_
   |PyValentina@readthedocs-badge|
   |PyValentina@pypi|_

.. |ohloh| image:: https://www.openhub.net/accounts/230426/widgets/account_tiny.gif
   :target: https://www.openhub.net/accounts/fabricesalvaire
   :alt: Fabrice Salvaire's Ohloh profile
   :height: 15px
   :width:  80px

.. |PyValentinaUrl| replace:: http://fabricesalvaire.github.io/PyValentina

.. |PyValentinaHomePage| replace:: PyValentina Home Page
.. _PyValentinaHomePage: http://fabricesalvaire.github.io/PyValentina

.. |PyValentinaDoc| replace:: PyValentina Documentation
.. _PyValentinaDoc: http://pyvalentina.readthedocs.org/en/latest

.. |PyValentina@readthedocs-badge| image:: https://readthedocs.org/projects/pyvalentina/badge/?version=latest
   :target: http://pyvalentina.readthedocs.org/en/latest

.. |PyValentina@github| replace:: https://github.com/FabriceSalvaire/PyValentina
.. .. _PyValentina@github: https://github.com/FabriceSalvaire/PyValentina

.. |PyValentina@readthedocs| replace:: http://pyvalentina.readthedocs.org
.. .. _PyValentina@readthedocs: http://pyvalentina.readthedocs.org

.. |PyValentina@pypi| replace:: https://pypi.python.org/pypi/PyValentina
.. .. _PyValentina@pypi: https://pypi.python.org/pypi/PyValentina

.. |Build Status| image:: https://travis-ci.org/FabriceSalvaire/PyValentina.svg?branch=master
   :target: https://travis-ci.org/FabriceSalvaire/PyValentina
   :alt: PyValentina build status @travis-ci.org

.. |Pypi Download| image:: https://img.shields.io/pypi/dm/PyValentina.svg
   :target: https://pypi.python.org/pypi/PyValentina
   :alt: PyValentina Download per month

.. |Pypi Version| image:: https://img.shields.io/pypi/v/PyValentina.svg
   :target: https://pypi.python.org/pypi/PyValentina
   :alt: PyValentina last version

.. |Pypi License| image:: https://img.shields.io/pypi/l/PyValentina.svg
   :target: https://pypi.python.org/pypi/PyValentina
   :alt: PyValentina license

.. |Pypi Format| image:: https://img.shields.io/pypi/format/PyValentina.svg
   :target: https://pypi.python.org/pypi/PyValentina
   :alt: PyValentina format

.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/PyValentina.svg
   :target: https://pypi.python.org/pypi/PyValentina
   :alt: PyValentina python version

..  coverage test
..  https://img.shields.io/pypi/status/Django.svg
..  https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star

.. End
.. -*- Mode: rst -*-

.. |Python| replace:: Python
.. _Python: http://python.org

.. |PyPI| replace:: PyPI
.. _PyPI: https://pypi.python.org/pypi

.. |Numpy| replace:: Numpy
.. _Numpy: http://www.numpy.org

.. |Sphinx| replace:: Sphinx
.. _Sphinx: http://sphinx-doc.org

.. End

============
 PyValentina
============

The official PyValentina Home Page is located at |PyValentinaUrl|

The latest documentation build from the git repository is available at readthedocs.org |PyValentina@readthedocs-badge|

Written by `Fabrice Salvaire <http://fabrice-salvaire.pagesperso-orange.fr>`_.

-----

.. -*- Mode: rst -*-

.. _installation-page:


==============
 Installation
==============

The installation of PyValentina by itself is quite simple. However it will be easier to get the
dependencies on a Linux desktop.

Dependencies
------------

PyValentina requires the following dependencies:

 * |Python|_ 3
 * |Numpy|_

Also it is recommanded to have these Python modules:

 * pip
 * virtualenv

For development, you will need in addition:

 * |Sphinx|_

Installation from PyPi Repository
---------------------------------

PyValentina is made available on the |Pypi|_ repository at |PyValentina@pypi|

Run this command to install the last release:

.. code-block:: sh

  pip install PyValentina

Installation from Source
------------------------

The PyValentina source code is hosted at |PyValentina@github|

To clone the Git repository, run this command in a terminal:

.. code-block:: sh

  git clone git@github.com:FabriceSalvaire/PyValentina.git

Then to build and install PyValentina run these commands:

.. code-block:: sh

  python setup.py build
  python setup.py install

.. End

.. End