Merge pull request #904 from sardana-org/release-Jul18

Release Jul18 (2.5.0)

.bumpversion.cfg

@@ -3,7 +3,7 @@ commit = True
 message = Bump version {current_version} to {new_version}
 tag = False
 tag_name = {new_version}
-current_version = 2.4.0
+current_version = 2.5.0
 parse = (?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)(\-(?P<release>[a-z]+))?
 serialize = 
 	{major}.{minor}.{patch}-{release}

.travis.yml

@@ -8,11 +8,19 @@ services:
   - docker
 
 python:
-  - "2.7"
+  - "3.6"
 
 env:
+  global:
+    # Doctr deploy key for sardana-org/sardana-doc
+    - secure: "p/0UgVZzPKJQqcvQ/97qMgo9kPCE0cZ6vI+308YEJ2o9xj4a3FsfHCZ/vWtjdsrp1sQbtKVDesx+xmK4CLDzQeC2+Xskv8OZDjaG2jYkHcVosZEM3EGW8rLVKzoDWLr6cTy2wexLgjHPCsmrjukPs49/i5p+WU0no64YoLlZdp9TT+gvWSQJLIk6R4eqt4FHMszPybLv0pvb1SEiCzimlX1WM1pBrE0LHgchd2ZBYSUWTTwe+Koi4HCS4Bads8j20K2e3fFKcmR2u9DfmU+7Mf5HRJsj1LYJgBUF76lUG2/fZfpoDe8sWi+eUewTa3zNM4bhRLpV+pmG0ypplM4pIcdvwiHV03nGSGu6XK6OGQ/Mgsw0fmud4JR4f5g9DgEfERlyJKI4A9mPZQ327OmEwOOl33x2AFJAL05Qvm0yXCkf1dwgYXnZl44SQbAczY1NHFL90t6xbHtmTitJrE2Xb+4BLzMe3OOZj6j/0QeiXA4z1FnZr1s8UoAsm68iW194IuFg1RRG9FTISFWaBew5wzwvAJak0DxkpG0k43VkHiVC7sPHqr5CxXMXO/MuaptK2ti6iLK9xBAEUpO9HluOkeJq5WDIIxBiBS9tPi0i3vIpq87RjHkdw5n7pdIqnuJ1nXUjpWsuUyV3fLkY12fFxSbZgqmNhIE5/o9c5VP/69Y="
+
+  matrix:
   - TEST="flake8"
-  - TEST="testsuite"
+  - TEST="testsuite" DOCKER_IMG=reszelaz/sardana-test
+  - TEST="testsuite" DOCKER_IMG=reszelaz/sardana-test:taurus-support-3.x
+  - TEST="doc" DOCKER_IMG=reszelaz/sardana-test
+
 
 before_install:
   # install flake8 to perform python code style check in the script part
@@ -23,8 +31,8 @@ before_install:
 
 install:
   # run reszelaz/sardana-test docker container (Debian8 with sardana-deps)
-  - if [ $TEST == "testsuite" ]; then docker pull reszelaz/sardana-test; fi
-  - if [ $TEST == "testsuite" ]; then docker run -d --name=sardana-test -h sardana-test --volume=`pwd`:/sardana reszelaz/sardana-test; fi
+  - if [ $TEST != "flake8" ]; then docker pull $DOCKER_IMG; fi
+  - if [ $TEST != "flake8" ]; then docker run -d --name=sardana-test -h sardana-test --volume=`pwd`:/sardana $DOCKER_IMG; fi
 
   # wait approx. 10 s (supervisor starts mysql and Tango DB)
   - if [ $TEST == "testsuite" ]; then sleep 10; fi
@@ -37,7 +45,31 @@ install:
   - if [ $TEST == "testsuite" ]; then docker exec sardana-test supervisorctl start MacroServer; fi
 
 script:
+  # make the script fail if a line fails
+  - set -e
   # run flake8 check on all python files in the project
   - if [ $TEST == "flake8" ]; then ci/flake8_diff.sh; fi
   # run the full testsuite
   - if [ $TEST == "testsuite" ]; then docker exec sardana-test sardanatestsuite; fi
+  # build docs
+  - if [ $TEST == "doc" ]; then
+      docker exec -t sardana-test /bin/bash -c "cd /sardana ; sphinx-build -W doc/source/ build/sphinx/html" ;
+    fi
+
+  # deploy sphinx docs to sardana-doc repo if we are on upstream
+  - if [[ $TEST == "doc" && $TRAVIS_REPO_SLUG == "sardana-org/sardana" ]]; then
+      pip install doctr ;
+      docker exec sardana-test /bin/bash -c "touch /sardana/build/sphinx/html/.nojekyll" ;
+      if [[ $TRAVIS_BRANCH == "develop" ]]; then
+        doctr deploy . ;
+      else
+        doctr deploy "v-$TRAVIS_BRANCH"  ;
+      fi;
+    fi
+
+doctr:
+  key-path : ci/github_deploy_key.enc
+  deploy-repo : sardana-org/sardana-doc
+  require-master: false
+  sync: true
+  built-docs: build/sphinx/html/

CHANGELOG.md

@@ -3,6 +3,81 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 This file follows the formats and conventions from [keepachangelog.com]
 
+## [Unreleased]
+
+## [2.5.0] 2018-08-10
+
+### Added
+- `def_discr_pos`, `udef_discr_pos` and `prdef_discr` macros for configuring
+  discrete pseudo motors (#801)
+- `Configuration` attribute to discrete pseudo motor (#801)
+- Avoid desynchronization of motion and acquisition in time synchronized
+  continuous scans by checking whether the motor controller accepts the scan
+  velocity and in case it rounds it up, reduce the scan velocity (#757)
+- `repeat` macro for executing n-times a set of macros passed as parameters
+  or attached as hooks (#310, #745, #892)
+- `pre-acq` and `post-acq` hooks to the `ct` macro (#808)
+- `pre-acq` and `post-acq` hooks to the continuous scans: `ascanct` family
+  macros (#780)
+- `pre-acq` and `post-acq` hooks to `timescan` macro (#885)
+- `SoftwareSynhronizerInitialDomain` Tango attribute to
+  the Measurement Group Tango device and `sw_synch_initial_domain` attribute
+  to the `PoolMeasurementGroup` (#759) - experimental
+- Default macro logging filter which improves the output of logging messages.
+  Filter can be configured with sardanacustomsettings (#730)
+- Possibiltiy to configure ORB end point for Tango servers with Tango DB
+  free property (#874)
+- Enhance software synchronization by allowing function generation when
+  group has 1 repeat only (#786)
+- Tab completion in spock for Boolean macro parameters (#871)
+- Information about controller properties in `sar_info` macro (#855, #866)
+
+### Fixed
+- Ensure that value buffer (data) events are handled sequentially so data
+  are not wrongly interpreted as lost (#794, #813)
+- Push change events from code for measurement group attributes: moveable,
+  latency time and synchronization (#736, #738)
+- `getPoolObj` random `AttributeErrors: _pool_obj` errors in macros (#865, #57)
+- Pre-scan snapshot (#753)
+- Avoid loading configuration to disabled controllers in measurement group
+  acquisition (#758)
+- Spock returning prompt too early not allowing to stop macros on Windows
+  (#717, #725, #905)
+- Validation of starts and finals for a2scanct, a3scanct, meshct, ... (#734)
+- `defelem` macro when using default axis number (#568, #609)
+- Boolean macro parameter validation - now works only True, true, 1
+  or False, false, 0 (#871)
+- Remove numpy and pylab symbols from spock namespace in order to
+  not collide with macros e.g. repeat, where, etc. (#893)
+- Make SPEC_FileRecorder use LF instead of CRLF even on windows (#750)
+- Appending of hooks from sequence XML (#747)
+- Avoid problems with MacroServer attributes (Environment and Elements) in
+  taurus extesnions by using newly introduced (in taurus 4.4.0) TangoSerial
+  serialization mode (#897)
+- Pseudo counters in continuous acquisition (#899)
+- Split of `PoolPath`, `MacroPath` and `RecorderPath` with OS separator (#762)
+- `lsgh` list hooks multiple times to reflect the configuration (#774)
+- Avoid errors if selected trajectory in HKL controller doesnot exists (#752)
+- Pass motion range information with `MoveableDesc` in `mesh` scan (#864)
+- `getElementByAxis` and `getElementByName` of Controller Taurus extension
+  class (#872)
+- `GScan` intervals estimation (#772)
+- `meshct` intervals estimation (#768)
+- Documentation on how to install and use Sardana from Git clone (#751)
+- Documentation (Sphinx) build warnings (#859, #179, #219, #393)
+
+### Changed
+- Change epoch from float to formatted date & time in Spec recorder (#766)
+- Documentation hosting from ReadTheDocs to Github Pages (build on Travis) (#826)
+- Door and MacroServer references in spock configuration file (profile) to
+  use FQDN URI references (#894, #668)
+
+### Deprecated
+- `Label` and `Calibration` attributes of discrete pseudo motor in favor
+  of `Configuration` attribute (#801)
+- `PoolMotorSlim` widget in favor of `PoolMotorTV` widget (#163, #785) 
+- `Controller.getUsedAxis` (Taurus device extension) in favor
+of `Controller.getUsedAxes` (#609)
 
 ## [2.4.0] 2018-03-14
 
@@ -396,7 +471,8 @@ Main improvements since sardana 1.5.0 (aka Jan15):
 
 
 [keepachangelog.com]: http://keepachangelog.com
-[Unreleased]: https://github.com/sardana-org/sardana/compare/2.3.2...HEAD
+[Unreleased]: https://github.com/sardana-org/sardana/compare/2.5.0...HEAD
+[2.5.0]: https://github.com/sardana-org/sardana/compare/2.4.0...2.5.0
 [2.4.0]: https://github.com/sardana-org/sardana/compare/2.3.2...2.4.0
 [2.3.2]: https://github.com/sardana-org/sardana/compare/2.3.1...2.3.2
 [2.3.1]: https://github.com/sardana-org/sardana/compare/2.3.0...2.3.1

CONTRIBUTING.md

@@ -30,10 +30,17 @@ For the contributions, we use the [Fork & Pull Model][]:
 In general, the contributions to sardana should consider following:
 
 - The code must comply with the [Sardana coding conventions][].
-  [Sardana travis-ci][] will check it for each Pull Request.
+  [Sardana travis-ci][] will check it for each Pull Request (PR) using
+  the latest version of [flake8 available on PyPI][]. The check
+  will be done just on this part of code that is modified by the PR
+  together with some lines of context.
   In case the check fails, please correct the errors and commit
-  to the Pull Request branch again. You may consider running the check locally
+  to the PR branch again. You may consider running the check locally
   using the [flake8_diff.sh][] script in order to avoid unnecessary commits.
+  If you find problems with fixing these errors do not hesitate to ask for
+  help in the PR conversation! We will not reject any contribution due
+  to these errors - the purpose of this check is just to maintain the code
+  base clean.
 
 - The contributor must be clearly identified. The commit author 
   email should be valid and usable for contacting him/her.
@@ -76,3 +83,4 @@ In general, the contributions to sardana should consider following:
 [LGPL]: http://www.gnu.org/licenses/lgpl.html
 [Sardana travis-ci]: https://travis-ci.org/sardana-org/sardana
 [flake8_diff.sh]: https://github.com/sardana-org/sardana/blob/develop/ci/flake8_diff.sh
+[flake8 available on PyPI]: https://pypi.org/project/flake8

ci/github_deploy_key.enc

@@ -0,0 +1 @@
+gAAAAABbRIlov7GgCqYKPx7wnaU_-rtYRBbbucfQIPnjSsA7UUntuTcOiyzb2qEr7FCyUtZ9q2fWJf6NFG-c8RFJP1CfnviMDruCzAPPmBgJilSFbtC5sXBme8gesFUylVmjo-vUWHqgcSFmtwWv-lKef9Y1Uj1IHkw7ujEPEb5CzqbqeNYLX0b2vaFJzj1ySQoAAXv5_M6Y6It5kSg2ob3DJvql-w81PkyrnqpcQbEtnSiRgrUCIAQQDpJFy2f-NPWcMqYh9yLnjvwfEKO8S6eSy8SLk26MMtzFhQ6-BO8DZSSmMkzX9gZqcEdM89jpA_Js-Cg10bAc_78Hia45GTgpfTISYGOQFLhpGun1-a5wxhdVieAr0pg2VtQ7n0mjwWlH2g28uYJF-VYuE5nrEa1KLXRVkTENLcZJlRjVD_JhfgGr6zWJ_pcebixZq_cxcvXP8_uM8YottdqrzsRt1XdhmUxe9SbBfgxZRGfvYlV_7LNs_WGsURlxxogTMVrq1bAFOB3c6tDZpEznpR0Ytgz-GJLSJv9IutdSjmeLCMQOlyvsTN33DAJtuQGoiwyJmz0SLWTC7ZSyUCqP9Wcu8ytcCK6jVoA1lYSPnvyWxH6xmTac9T9KQngJTmqvni5fOb4LjWGU0ILfWAZijgg7YlKSrqlEsuJ3gOTx0q7vpG5Z6e7cXMtGFTR4t7IhSnyaCDv7ox9kKq3Xv7p4MM00M58XH25SaY0yPnGlMqn0HWZFgAXuPHqrSz2kxWEsL4q3YRtc944ZP89Mwi-HgcWBSTPwbDmvPlls-GxEu8QB5fT51oHNY4H0VGs7Tjp9xVjysZGa9x439a-mj8LsTPqrUFuHw9_EXOENL0iCiD9vqTAWodsnGX2nm3FVXAuRwwwzeSwagrtQ6aUP47pOaBmq9uKaZT6iEE8g8eSCBNnn7WwDrGy5C4Me3zMAuwjjoB0nlr60oSps7vF9Pi-89P0AN1DS15i5pWObQ-fqQ2aKaobRXrBIhFxL1eCijkNxVDfM1mkbz087J6qw2iQwzpkkjSawZ4rdyWrZyQeGjhiVfIT22R67KUvYrVEguzUA8Q3IgmvbKhkLSPX3FUQfiSM_rKdBy_iO02bJU4glsR_G1QM4RMOy0LIEOGdcaq36H4QCSX76FNekSFGLmi1b3NQXYH58QC8rPmqNTIRQ6c90ukL33AxuQ7-VPpLkyqhaOCR_WD-SVzPOcU4RiJ6h99_-BRcUG0-3pIswrool-FrJLVZdVFqkmRxDPhLutS_m0gpShNBZYUZAtvd7s1nBYzjcDg1Q_087r7PE6EeCMyuE2sngwlgAuA8Q2p7zxaWR-D8mkxYxvlKyXII4MADXGwLjP7S27uBWcRVAjLEvjZC12vVcKA7sB8XQWcpmAvXT3PX6bZAW94qygrAWZaSzY9hSmBt5p8OXeEzNv6rNDLlK40mFl5eILbwwJfKvfl9pwlKxU67NHSKk_FQBkEsHolpyQqEv5MBI0zoBXQp4GxXaa7oGfivqxhDikjAS7MhcKjVKtx1fyEOusBRsl_4DJMZf4Oe58ZjEeCFnN2icFFv7SVjt7MoWYiEDVvh3thabHJKMk3cjlYlFFmIsU4_2HZw5FEuTt0Be1cQ4hExpPp7qWfwveFjQEo5uAjCj-3yuAzcIEPIR3-zHLh5GrvFVzkjlaEyDxnmjSeNrZW4b92puM0LiU9mX4HtZMOVElLeMkGt104anXkPmb0r62zduLazKqqY0pJDwFCtpqz8ZZRJ8gCj2DVanjGUvwNA2fDrl5Ddo3HWgrY7xpt6J-i5EnYWDLfy5-oprR3ruYaUtmhHifnWr305Ok3Q_ufdQzzF8fStuZfM8F9pFFiKOmY1v3mpBazvUgZlWI3uGIWXMoC-A15eB7bnYstNK4i_XW8lG8J4pUzNvM5GpoHPgpsSR-vyonQ8c9igB3Rd3A7eOhbvdxde360F4PubKvMQdcBCq9mfjsng3h2rGE5y33LB3o9WuyojRQxA9elnIMwfttkwnbTjX1pNfPVq6cFso5mhz_PKHSpr9b8V31hHiLh6Pdd2ODJkM72gUfsAoBvdmOcgSweu4kWkzT3urHb0T4o6P9fAlad39ibLw0qrT_ZqRpXXllnXF5j2OU0-a74gZ7p-8fGUKxTrjS6ZXlaQSABj697j52m9BHI07hKY5p8fNA0G28vZHBh3UkbYT8aZzxQFFDVMn8DJKSDZ7_F9VWXk9WvpGGNU1CTxx-d6VdohDRyp0BKbC5Qo32DEwvBHH33nLkb8NX22ghaFDbH940VlzlLcUb8-a8WIcVrYpOf0PHW2vt0lRZHfuS6CriioKf27GnQvhaGjk1mz0dxbk4gSVW3iULUxBpJqgxJkAoz-F5J-NuQpSZu4qhcfV-BRVrsweVe8obsfmxSbCZVt3hekGfYdUXVKJ8dKLDuY9H93beDryU_1AUyQ6S-7V7J992bKEPRvHzaHVeUC4jV2ySHN02Pi10XbQKHGQeF6UsajKnapmOfSpswJ6jteVePciOSy28suwX2a3LFB-t8fhUiSkh_tftosUA5_GeHE5XD8fDZ7hOV3IgKfnCzFfuPmuJ6Q4p3SlLXXpqXio8_e6DIIv7FWN4rdAVVbJ_gBp8C3RcZliAMk20VdXbIuLLAAnG8VxAzlfc40qACEI1ENoc4EcEospcqjhYKlIqyyOthOpjmPJpmD888ByRz4QfN3JIUUowt2WwLOYEekM_qIlkG-FL0qNqaXM2UXqphOQrhbVv23vTMvd0ZAwF5capxx2LOLj-99LMozheoDUCCYWTou586AH_B7zKiRFvphTUwY36maORbcQQeaUtMaV0ud5hEhHhNo-80-mJlBBs0ZPSWBYCC1u6H0Dtq1GISIde_TYl0xRxqH24xYEpIIhrTzpibpJipAH4c06RQzf1tAn70Oq6YfyjJ_Y2aekx3tHY0CCcnAa5FI-aOhHSilKLEKIuUKJ0kx0WTBv7YVElN7yDFYnHZFVJBMNQ5KOmvAzBl1T-ISGrD8VlXg2c-vY3DN1IEvQDZ8WdWupuoEDaSByTx5MOx3taOo_zVGZYHkXDQ00oP3aTDsEPIqEGsAz7B9Y_uOvGQt2-T0WJxwDlTDPbGnuHnIYHq9U9c4RbVjLr0EOWm2_4kCZ63EX9z31gkwXfp5R97rSnpFpQG_LubMx33fXvz2mxhvTmSNJdAOgHNv6ygfSFsHumAkXl6HcjV0XTKOUhVd49QRNF3J32ILKL_X5jHJCMgWTZSOvN3TzOa6VToe_zB4ndYtnNwqDQUjrKYRAcP3Wg7t4yaAhhiOTmOO1B2EhKlemf6_El8k8aWYfZDS5VHHL0V6qUu5-KExQt6lqQZvSq2a5nmMfBC6KQlKo5jNzqGbVsaBznr32H6IG0cQU6M0jTbZUozFcCFi9vmXfcBaSmC-0ZUYicazGsU46OuJJFHi2F0_TT-N-p3epLHDbAU35ig1zxbV4prBLoPi8cUMIBqOaaQiC2eHxGVSuYy9s4MdnwkmnM3fwumQTFf4QCAaRE5l2Yg6PAh92uUJ9yB4cCYZgovsRhXq5vjHRk2auc0_gk9Mu_vGqqLnn0E5W01I9hJJnvYVng-sI77zRGr9CzjT-ZvqziNN1iBX1sjpKbi13vzxTt8dWUvPpK8o26bPdBFbbdbEL2kHoALkMl_CV2d72RDdzBG0auwfXVp2XpfWuyMDBgO8IYrUSDjFiW2puwctD__MMkBSiFlouxJo6gxrgbpsMiSdshGjqD3rajyqcGcSnBI0BlgbfME6-cZhRZLz708IV_ai02M2jMq3cioYfjl7cCSpoNgLR0vbrG6Sc5-SexhnGGMVwtq4ej95FnixkAfhykHSBbF-_-SAVCI2h6_grHfYOwIr7cm2QqXCj1PtZPS-bk-3huXKzUneCHDnKjUntlgBN7ntkH0d44fP1iguT_FgWVzJUKFB2-9GJ0k6I792ChiBIFqT0BxAbWCOeoN40EKS0Bh4djTsBXzAp9GAGmrnITBKsBDhHxfzCLlE3C2m1dyS8t7AtECFlxbWFm-4e9iYmuvwTyFGjPab98-G6XE28NL877r-Q9vhe8kx7R8HMF3Egp_slP2gLwhRL6CL_PTxQNfFSFXy7wJV1H3bOV8jWYgTmkFO-gcyk8QFzuLWFPZtiZAku3eY5eC7ta1a_BTJ3e8tdcad2UXm7jjw1eQzTrZSL8Ry5_ejvprgtioukZq29hWH9xv2tApQJHCKy2QlYTkZVBFAYLq6ScNky6y28YEzzR2lcMI3sEJX50JHILn8hf7snFQ1Ns8EQRVKTcxFCnKuUA-SAOBbQYfhpql2qC4sClLlb3ieMmxOmhLAaANtcKRS7_wOdRcG6HNeC4vMZBohlvZQ4pvNkeGe9PDNGQSKPMoeSJZ01S2a-49VHXGHc2IwrGLFfMxXWoLUy6w==