Merge pull request #294 from tango-controls/prepare-v9.3.1

    >>> import tango

    >>> print(tango.utils.info())

    PyTango 9.2.6 (9, 2, 6, 'dev', 0)

    PyTango 9.3.1 (9, 3, 1)

    PyTango compiled with:

        Python : 2.7.15

        Numpy  : 1.15.4

        Tango  : 9.2.5

        Numpy  : 1.16.2

        Tango  : 9.3.3

        Boost  : 1.67.0

    PyTango runtime is:

        Python : 2.7.15

        Numpy  : 1.15.4

        Tango  : 9.2.5

        Numpy  : 1.16.2

        Tango  : 9.3.3

        Boost  : 0.0.0

    PyTango running on:

    ('Linux', 'hostname', '4.4.0-131-generic', '#157-Ubuntu SMP Thu Jul 12 15:51:36 UTC 2018', 'x86_64', 'x86_64')

    ('Linux', 'hostname', '4.4.0-131-generic', '#157-Ubuntu SMP Sat Jul 27 06:00:36 UTC 2019', 'x86_64', 'x86_64')

For an interactive use, consider using ITango_, a tango IPython_ profile.

Pick a version number

  * Semantic version numbering is used:  <major>.<minor>.<patch>

  * The major and minor version fields (9.2) track the TANGO C++ core version.

  * The major and minor version fields (9.3) track the TANGO C++ core version.

  * Small changes are done as patch releases.  For these the version

    number should correspond the current development number since each

    release process finishes with a version bump.

  * Patch release example:

      - ``9.2.6.devN`` or ``9.2.6aN`` or ``9.2.6bN`` (current development branch)

      - changes to ``9.2.6`` (the actual release)

      - changes to ``9.2.7.dev0`` (bump the patch version at the end of the release process)

      - ``9.3.1.devN`` or ``9.3.1aN`` or ``9.3.1bN`` (current development branch)

      - changes to ``9.3.1`` (the actual release)

      - changes to ``9.3.2.dev0`` (bump the patch version at the end of the release process)

Create an issue in Github

  * This is to inform the community that a release is planned.

    | Task list:

    | - [ ] Read steps in the how-to-contribute docs for making a release

    | - [ ] Edit the changelog

    | - [ ] Bump the version

    | - [ ] Pull request to update changelog and bump version

    | - [ ] Merge PR (this is the last PR for the release)

    | - [ ] Merge develop into stable

    | - [ ] Make sure Travis is OK on stable branch

    | - [ ] Make sure the documentation is updated (readthedocs)

    | - [ ] Make sure Travis and Appveyor are OK on stable branch

    | - [ ] Make sure the documentation is updated for stable (readthedocs)

    | - [ ] Create a release tag on GitHub, from stable branch

    | - [ ] Make sure the documentation is updated for release (readthedocs)

    | - [ ] Upload the new version to PyPI

    | - [ ] Bump the version with "-dev" in the develop branch

    | - [ ] Fill the release description on GitHub

    | - [ ] Advertise the release on the mailing list

    | - [ ] Close this issue

  * A check list is this form on github can be ticked off as the work progresses.

  * A check list in this form on github can be ticked off as the work progresses.

Make a branch from ``develop`` to prepare the release

  * Example branch name: ``prepare-v9.2.6``.

  * Example branch name: ``prepare-v9.3.1``.

  * Edit the changelog (in ``docs/revision.rst``).  Include *all* pull requests

    since the previous release.

  * Bump the versions in (in ``tango/release.py``).  E.g. ``version_info`` to (9, 2, 6)

  * Bump the versions (``tango/release.py`` and ``appveyor.yml``).

    E.g. ``version_info = (9, 3, 1)``, and ``version: 9.3.1.{build}``

  * Create a pull request to get these changes reviewed before proceeding.

Merge ``stable`` into ``develop``

    ``stable`` and ``develop`` branches.

  * In general, the ``stable`` branch should point to the latest release.

Make sure Travis is OK on ``stable`` branch

  * All tests, on all versions of Python must be passing.

Make sure Travis and AppVeyor are OK on ``stable`` branch

  * On Travis, all tests, on all versions of Python must be passing.

    If not, bad luck - you'll have to fix it first, and go back a few steps...

  * On AppVeyor, all builds, on all versions of Python must be passing.

    If not, bad luck - you'll have to fix it first, and go back a few steps...

Make sure the documentation is updated

  * Readthedocs *should* automatically build the docs for each:

      - push to develop (latest docs)

      - push to stable (stable docs)

      - new tags (e.g v9.2.x)

      - new tags (e.g v9.3.1)

  * *But*, the webhooks are somehow broken, so it probably won't work automatically!

      - Trigger the builds manually here:  https://readthedocs.org/projects/pytango/builds/

      - Set the new version to "active" here:

Create a release tag on GitHub

  * On the Releases page, use "Draft a new release".

  * Tag must match the format of previous tags, e.g. ``v9.2.6``.

  * Tag must match the format of previous tags, e.g. ``v9.3.1``.

  * Target must be the ``stable`` branch.

Upload the new version to PyPI

  * Log in to https://pypi.org.

  * Get account permissions for PyTango from another contributor, if necessary.

  * If necessary, pip install twine: https://pypi.org/project/twine/)

  * Build update and upload, from the the ``stable`` branch:

  * Build release from the tagged commit:

      - ``$ git clean -xfd  # Warning - remove all non-versioned files and directories``

      - ``$ git fetch``

      - ``$ git checkout v9.3.1``

      - ``$ python setup.py sdist``

      - ``$ twine upload dist/pytango-9.2.N.tar.gz``

  * Optional:  Upload to https://test.pypi.org, and make sure all is well:

      - ``$ twine upload -r testpypi dist/pytango-9.3.1.tar.gz``

  * Optional:  Test installation (in a virtualenv):

      - ``$ pip install -i https://test.pypi.org/simple/ pytango``

  * Upload the source tarball to the real PyPI:

      - ``$ twine upload dist/pytango-9.3.1.tar.gz``

  * Run build for the tag on AppVeyor, download artifacts, and upload wheels:

      - ``$ twine upload dist/pytango-9.3.1-cp27-cp27m-win32.whl``

      - ``$ twine upload dist/pytango-9.3.1-cp27-cp27m-win_amd64.whl``

      - ``$ twine upload dist/pytango-9.3.1-cp36-cp36m-win32.whl``

      - ``$ twine upload dist/pytango-9.3.1-cp36-cp36m-win_amd64.whl``

      - ``$ twine upload dist/pytango-9.3.1-cp37-cp37m-win32.whl``

      - ``$ twine upload dist/pytango-9.3.1-cp37-cp37m-win_amd64.whl``

Bump the version with "-dev" in the develop branch

  * Change all references to next version.  E.g. if releasing

    v9.2.6, then update references to v9.2.6.

    v9.3.1, then update references to v9.3.2.

  * This includes files like ``README.rst``, ``doc/howto.rst``, ``doc/start.rst``.

  * In ``tango/release.py``, change ``version_info``, e.g. from ``(9, 2, 6)`` to

    ``(9, 2, 7, 'dev', 0)``.

  * In ``tango/release.py``, change ``version_info``, e.g. from ``(9, 3, 1)`` to

    ``(9, 3, 2, 'dev', 0)``.

  * In ``appveyor.yml``, change ``version``, e.g. from ``9.3.1.{build}`` to

    ``9.3.2.dev0.{build}``.

Fill in the release description on GitHub

  * Content must be the same as the details in the changelog.  List all the

    >>> import tango

    >>> tango.__version__

    '9.2.6'

    '9.3.1'

    >>> tango.__version_info__

    (9, 2, 6)

    (9, 3, 1)

and the Tango C++ library version that PyTango was compiled with::

    >>> import tango

    >>> tango.constants.TgLibVers

    '9.2.5'

    '9.3.3'

Report a bug

+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+

| 13/03/19 | `9.3.0 <http://pytango.readthedocs.io/en/v9.3.0>`_                               | 9.3.0 Release                                       | T\. Coutinho                   |

+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+

| 07/08/19 | `9.3.1 <http://pytango.readthedocs.io/en/v9.3.1>`_                               | 9.3.1 Release                                       | A\. Joubert                    |

+----------+----------------------------------------------------------------------------------+-----------------------------------------------------+--------------------------------+

.. _pytango-version-history:

+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+

| Version  | Changes                                                                                                                                                               |

+==========+=======================================================================================================================================================================+

| 9.3.1    | 9.3.1 release.                                                                                                                                                        |

|          |                                                                                                                                                                       |

|          | Changes:                                                                                                                                                              |

|          |     - `Pull Request #277: Windows builds using AppVeyor (#176) <https://github.com/tango-controls/pytango/pull/277>`_                                                 |

|          |     - `Pull Request #290: Update docs: int types maps to DevLong64 (#282) <https://github.com/tango-controls/pytango/pull/290>`_                                      |

|          |     - `Pull Request #293: Update exception types in proxy docstrings <https://github.com/tango-controls/pytango/pull/293>`_                                           |

|          |                                                                                                                                                                       |

|          | Bug fixes:                                                                                                                                                            |

|          |     - `Pull Request #270: Add six >= 1.12 requirement (#269) <https://github.com/tango-controls/pytango/pull/270>`_                                                   |

|          |     - `Pull Request #273: DeviceAttribute.is_empty not working correctly with latest cpp tango version (#271) <https://github.com/tango-controls/pytango/pull/273>`_  |

|          |     - `Pull Request #274: Add unit tests for spectrum attributes, including empty (#271) <https://github.com/tango-controls/pytango/pull/274>`_                       |

|          |     - `Pull Request #281: Fix DevEncoded commands on Python 3 (#280) <https://github.com/tango-controls/pytango/pull/281>`_                                           |

|          |     - `Pull Request #288: Make sure we only convert to string python unicode/str/bytes objects (#285) <https://github.com/tango-controls/pytango/pull/288>`_          |

|          |     - `Pull Request #289: Fix compilation warnings and conda build (#286) <https://github.com/tango-controls/pytango/pull/289>`_                                      |

|          |                                                                                                                                                                       |

+----------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------+

| 9.3.0    | 9.3.0 release.                                                                                                                                                        |

|          |                                                                                                                                                                       |

|          | Changes:                                                                                                                                                              |

.. sourcecode:: console

    $ python -c "import tango; print(tango.Release.version)"

    9.2.6

    9.3.1

Next steps: Check out the :ref:`pytango-quick-tour`.