[pytango] 70/98: Use a ReST readme file as long description

[Sandor Bodo-Merle]

This is an automated email from the git hooks/post-receive script.

sbodomerle-guest pushed a commit to tag v9.2.0
in repository pytango.

commit 3b7f531b602187be3b1de5f18436a4072a4eedaf
Author: Vincent Michel <vincent.michel at maxlab.lu.se>
Date:   Mon Jul 11 16:37:53 2016 +0200

    Use a ReST readme file as long description
---
 README.md        |  19 ----------
 README.rst       | 108 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.py         |   4 ++-
 tango/release.py |   4 +--
 4 files changed, 113 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
deleted file mode 100644
index dc235cb..0000000
--- a/README.md
+++ /dev/null
@@ -1,19 +0,0 @@
-# PyTango
-
-PyTango is a python module that exposes to <a href="http://www.python.org/">Python</a>
-the complete <a href="http://www.tango-controls.org/">Tango</a> C++ API.
-This means that you can write not only tango applications (scripts, CLIs, GUIs) that 
-access tango device servers but also tango device servers themselves, all of this in
-pure python.
-
-The latest version of the documentation can be found 
-<a href="http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/index.html">here</a>.
-
-Check out the <a href="http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/start.html#getting-started"><em>getting started guide</em></a>
-to learn how to build and/or install PyTango and after that the 
-<a href="http://www.esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango/latest/quicktour.html#quick-tour"><em>quick tour</em></a>
-can help you with the first steps in the PyTango world.
-
-If you need help understanding what Tango itself really is, you can check the
-<a href="http://www.tango-controls.org/">Tango</a> homepage where you will 
-find plenty of documentation, FAQ and tutorials.
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..ef6846b
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,108 @@
+PyTango
+=======
+
+Python binding for Tango_, a library dedicated to distributed control systems.
+
+
+Description
+-----------
+
+PyTango_ exposes the complete `Tango C++ API`_ through the ``tango`` python module.
+It also adds a bit of abstraction by taking advantage of the Python capabilites:
+
+- ``tango.client`` provides a client access to device servers and databases.
+- ``tango.server`` provides base classes to declare and run device servers.
+
+
+Requirements
+------------
+
+PyTango_ is compatible with python 2 and python 3.
+
+General dependencies:
+
+-  libtango_ >= 9.2
+-  `Boost.Python`_ >= 1.33
+
+Python dependencies:
+
+-  numpy_ >= 1.1
+-  six_
+
+Build dependencies:
+
+- setuptools_
+- sphinx_
+
+Optional dependencies:
+
+- futures_
+- gevent_
+
+.. note:: As a general rule, libtango_ and pytango_ should share the same major
+	  and minor version (for a version ``X.Y.Z``, ``X`` and ``Y`` should
+	  match)
+
+
+Install
+-------
+
+PyTango_ is available on PyPI_ as ``pytango``::
+
+    $ pip install pytango
+
+Alternatively, PyTango_ can be built and installed from the
+`sources <PyTango_>`__::
+
+    $ python setup.py install
+
+In both cases, the installation takes a few minutes since the ``_tango`` boost
+extension has to compile.
+
+
+Usage
+-----
+
+To test the installation, import ``tango`` and check ``tango.__version__``::
+
+    >>> import tango
+    >>> tango.__version__
+    '9.2.0'
+
+For an interactive use, consider using ITango_, a tango IPython_ profile.
+
+
+Documentation
+-------------
+
+Check out the `documentation <Documentation_>`__ for more informations.
+
+
+
+Support and contribution
+------------------------
+
+You can get support from the `Tango forums`_, for both Tango_ and PyTango_ questions.
+
+All contributions,  `PR and bug reports <PyTango_>`__ are welcome!
+
+
+.. _Tango: http://tango-controls.org/
+.. _Tango C++ API: http://esrf.eu/computing/cs/tango/tango_doc/kernel_doc/cpp_doc/index.html
+.. _PyTango: http://github.com/tango-cs/PyTango
+.. _PyPI: http://pypi.python.org/pypi/pytango
+
+.. _libtango: http://tango-controls.org/downloads/source/
+.. _Boost.Python: http://boost.org/doc/libs/1_61_0/libs/python/doc/html/index.html
+.. _numpy: http://pypi.python.org/pypi/numpy
+.. _six: http://pypi.python.org/pypi/six
+.. _setuptools: http://pypi.python.org/pypi/setuptools
+.. _sphinx: http://pypi.python.org/pypi/sphinx
+.. _futures: http://pypi.python.org/pypi/futures
+.. _gevent: http://pypi.python.org/pypi/gevents
+
+.. _ITango: http://pypi.python.org/pypi/itango
+.. _IPython: http://ipython.org
+
+.. _Documentation: http://esrf.eu/computing/cs/tango/tango_doc/kernel_doc/pytango
+.. _Tango forums: http://tango-controls.org/community/forums
diff --git a/setup.py b/setup.py
index fca8769..3ebd62a 100644
--- a/setup.py
+++ b/setup.py
@@ -495,11 +495,13 @@ def setup_args():
     if sphinx:
         cmdclass['build_doc'] = build_doc
 
+    long_description = open('README.rst').read()
+
     opts = dict(
         name='pytango',
         version=Release.version,
         description=Release.description,
-        long_description=Release.long_description,
+        long_description=long_description,
         author=author[0],
         author_email=author[1],
         url=Release.url,
diff --git a/tango/release.py b/tango/release.py
index 41329dc..696dd3a 100644
--- a/tango/release.py
+++ b/tango/release.py
@@ -51,7 +51,7 @@ class Release:
     license = 'LGPL'
     authors = { 'Coutinho' : ('Tiago Coutinho' , 'coutinho at esrf.fr') }
     author_lines = "\n".join([ "%s <%s>" % x for x in authors.values()])
-    url = 'http://www.esrf.fr/computing/cs/tango/pytango/'
-    download_url = 'http://pypi.python.org/pypi/PyTango'
+    url = 'http://github.com/tango-cs/pytango'
+    download_url = 'http://pypi.python.org/pypi/pytango'
     platform = ['Linux', 'Windows XP/Vista/7/8']
     keywords = ['Tango', 'CORBA', 'binding']

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pytango.git