DOC: Minor update, show package badges, use "python3"

Author: mgeier

CONTRIBUTING.rst

@@ -3,36 +3,36 @@ Contributing
 
 If you find bugs, errors, omissions or other things that need improvement,
 please create an issue or a pull request at
-http://github.com/spatialaudio/jackclient-python.
+https://github.com/spatialaudio/jackclient-python.
 Contributions are always welcome!
 
-Instead of pip-installing the latest release from PyPI, you should get the newest
-development version from Github_::
+Instead of pip-installing the latest release from PyPI, you should get the
+newest development version from Github_::
 
    git clone https://github.com/spatialaudio/jackclient-python.git
    cd jackclient-python
-   python setup.py develop --user
+   python3 setup.py develop --user
 
-.. _Github: http://github.com/spatialaudio/jackclient-python/
+.. _Github: https://github.com/spatialaudio/jackclient-python/
 
 This way, your installation always stays up-to-date, even if you pull new
 changes from the Github repository.
 
 If you prefer, you can also replace the last command with::
 
-   pip install --user -e .
+   python3 -m pip install --user -e .
 
 ... where ``-e`` stands for ``--editable``.
 
-If you make changes to the documentation, you can re-create the HTML pages
-using Sphinx_.
+If you make changes to the documentation, you can locally re-create the HTML
+pages using Sphinx_.
 You can install it and a few other necessary packages with::
 
-   pip install -r doc/requirements.txt --user
+   python3 -m pip install -r doc/requirements.txt --user
 
 To create the HTML pages, use::
 
-   python setup.py build_sphinx
+   python3 setup.py build_sphinx
 
 The generated files will be available in the directory ``build/sphinx/html/``.
 
@@ -41,7 +41,7 @@ The generated files will be available in the directory ``build/sphinx/html/``.
 There are no proper tests (yet?), but the code examples from the README file
 can be verified by::
 
-   python setup.py test
+   python3 setup.py test
 
 This uses py.test_; if you haven't installed it already, it will be downloaded
 and installed for you.

README.rst

@@ -7,14 +7,17 @@ Documentation:
    http://jackclient-python.rtfd.org/
 
 Code:
-   http://github.com/spatialaudio/jackclient-python/
-
-Python Package Index:
-   http://pypi.python.org/pypi/JACK-Client/
+   https://github.com/spatialaudio/jackclient-python/
 
 License:
    MIT -- see the file ``LICENSE`` for details.
 
+.. image:: https://badge.fury.io/py/JACK-Client.svg
+   :target: https://pypi.python.org/pypi/JACK-Client/
+
+.. image:: https://repology.org/badge/vertical-allrepos/python:jack-client.svg
+   :target: https://repology.org/metapackage/python:jack-client
+
 Requirements
 ------------
 
@@ -29,19 +32,24 @@ pip/setuptools:
    Those are needed for the installation of the Python module and its
    dependencies.  Most systems will have these installed already, but if not,
    you should install it with your package manager or you can download and
-   install pip and setuptools as described on the `pip installation`_ page.
-   If you happen to have pip but not setuptools, use this command::
+   install ``pip`` and ``setuptools`` as described on the `pip installation`_
+   page.
+   If you happen to have ``pip`` but not ``setuptools``, use this command::
 
-      pip install setuptools --user
+      python3 -m pip install setuptools --user
+
+   To upgrade to a newer version of an already installed package (including
+   ``pip`` itself), use the ``--upgrade`` flag.
 
 CFFI:
    The `C Foreign Function Interface for Python`_ is used to access the C-API
    of the JACK library from within Python.  It supports CPython 2.6, 2.7, 3.x;
-   and is distributed with PyPy_ 2.0 beta2 or later.
-   You should install it with your package manager (if it's not installed
-   already), or you can get it with::
+   and is distributed with PyPy_.
+   If it's not installed already, you should install it with your package
+   manager (the package might be called ``python3-cffi`` or similar), or you can
+   get it with::
 
-      pip install cffi --user
+      python3 -m pip install cffi --user
 
 JACK library:
    The JACK_ library must be installed on your system (and CFFI must be able
@@ -59,33 +67,37 @@ NumPy (optional):
    The only place where NumPy is needed is `jack.OwnPort.get_array()`.
    If you need NumPy, you should install it with your package manager or use a
    Python distribution that already includes NumPy (see above).
-   Installing NumPy with pip requires a compiler and several additional
-   libraries and is therefore not recommended for beginners.
+   You can also install NumPy with ``pip``, but depending on your platform, this
+   might require a compiler and several additional libraries::
+
+      python3 -m pip install NumPy --user
 
 .. _JACK: http://jackaudio.org/
 .. _NumPy: http://www.numpy.org/
-.. _Python: http://www.python.org/
-.. _Anaconda: http://docs.continuum.io/anaconda/
+.. _Python: https://www.python.org/
+.. _Anaconda: https://www.anaconda.com/download/
 .. _WinPython: http://winpython.github.io/
 .. _C Foreign Function Interface for Python: http://cffi.readthedocs.org/
 .. _PyPy: http://pypy.org/
 .. _JACK download page: http://jackaudio.org/downloads/
-.. _pip installation: http://www.pip-installer.org/en/latest/installing.html
+.. _pip installation: https://pip.pypa.io/en/latest/installing/
 
 Installation
 ------------
 
 Once you have installed the above-mentioned dependencies, you can use pip
 to download and install the latest release with a single command::
 
-   pip install JACK-Client --user
+   python3 -m pip install JACK-Client --user
 
 If you want to install it system-wide for all users (assuming you have the
 necessary rights), you can just drop the ``--user`` option.
+If you have installed the module already, you can use the ``--upgrade`` flag to
+get the newest release.
 
 To un-install, use::
 
-   pip uninstall JACK-Client
+   python3 -m pip uninstall JACK-Client
 
 If you want to avoid installation altogether, you can simply copy ``jack.py``
 to your working directory (or to any directory in your Python path).

jack.py

@@ -896,8 +896,8 @@ def set_process_callback(self, callback):
            If you can live with some random audio drop-outs now and
            then, feel free to continue using Python!
 
-        __ http://en.wikipedia.org/wiki/Global_Interpreter_Lock
-        __ http://en.wikipedia.org/wiki/Garbage_collection_(computer_science)
+        __ https://en.wikipedia.org/wiki/Global_Interpreter_Lock
+        __ https://en.wikipedia.org/wiki/Garbage_collection_(computer_science)
 
         .. note:: This function cannot be called while the client is
            activated (after `activate()` has been called).