This repository contains a set of scripts that are used by the
.travis.yml
and appveyor.yml
files of astropy packages for the
Travis and AppVeyor
services respectively.
The idea is to clone these at the last minute when the continuous integration is about to be run. This is better than including this repository as a sub-module, because this allows updates to this repository to take effect immediately, and not have to update the sub-module every time a change is made.
Include the following lines at the start of the install
section in .travis.yml
:
install:
- git clone git://github.com/astropy/ci-helpers.git
- source ci-helpers/travis/setup_conda_$TRAVIS_OS_NAME.sh
This does the following:
- Set up Miniconda.
- Set up the PATH appropriately.
- Set up a conda environment named 'test' and switch to it.
- Set the
always_yes
config option for conda totrue
so that you don't need to include--yes
. - Register the specified channels, or if not stated the
astropy
,astropy-ci-extras
, andopenastronomy
channels. export PYTHONIOENCODING=UTF8
Following this, various dependencies are installed depending on the following environment variables
-
MAIN_CMD
: if this starts withpep8
, then the only package that gets installed is thepep8
package. -
SETUP_CMD
: this can be set to various values:-
egg_info
: no dependencies are installed once the conda environment has been created and any other environment variables are ignored. -
build_sphinx
orbuild_docs
: the Sphinx and matplotlib packages are installed in addition to other packages that might be requested via other environment variables. -
test
: runs the test suite after the dependencies are installed.
In addition, if
SETUP_CMD
contains the following flags, extra dependencies are installed:--coverage
: the coverage and coveralls packages are installed--parallel
: the pytest-xdist package is installed--open-files
: the psutil package is installed
-
-
$NUMPY_VERSION
: if set todev
ordevelopment
, the latest developer version of Numpy is installed along with Cython. If set to a version number, that version is installed. If set tostable
, install the latest stable version of Numpy. If set toprerelease
, the pre-release version of Numpy gets installed if there is any, otherwise the build exits and passes on travis without running the tests. -
$ASTROPY_VERSION
: if set todev
ordevelopment
, the latest developer version of Astropy is installed, along with Cython and jinja2, which are compile-time dependencies. If set to a version number, that version is installed. If set tostable
, install the latest stable version of Astropy. If set toprerelease
, the pre-release version of Astropy gets installed if there is any, otherwise the build exits and passes on travis without running the tests. If set tolts
the latest long term support (LTS) version is installed (more info about LTS can be found here. -
$CONDA_DEPENDENCIES
: this should be a space-separated string of package names that will be installed with conda. Version numbers of these dependencies can be overridden/specified with the$PACKAGENAME_VERSION
environment variables. -
$PIP_DEPENDENCIES
: this should be a space-separated string of package names that will be installed with pip. -
CONDA_DEPENDENCIES_FLAGS
: additional flags to pass to conda when installingCONDA_DEPENDENCIES
-
PIP_DEPENDENCIES_FLAGS
: additional flags to pass to pip when installingPIP_DEPENDENCIES
-
$CONDA_CHANNELS
: this should be a space-separated string of conda channel names, and defaults toastropy
,astropy-ci-extras
, andopenastronomy
. -
$DEBUG
: ifTrue
this turns on the shell debug mode in the install scripts, and provides information on the current conda install and switches off the-q
conda flag for verbose output. -
$SETUP_XVFB
: if True this makes sure e.g., interactive matplotlib backends work by starting up a X virtual framebuffer. -
$PACKAGENAME_VERSION
:PACKAGENAME
is the name of the package to specify the version for (e.g.MATPLOTLIB_VERSION
). Due to shell limitations, all hyphens in the conda package name should be changed to underscores in$PACKAGENAME_VERSION
(e.g. for scikit-image it should beSCIKIT_IMAGE_VERSION
). If specified it will override any version number limitations listed in$CONDA_DEPENDENCIES
.
The idea behind the MAIN_CMD
and SETUP_CMD
environment variables is
that the script
section of the .travis.yml
file can be set to:
script:
- $MAIN_CMD $SETUP_CMD
The typical usage will then be to set $MAIN_CMD
to default to python setup.py
and then set $SETUP_CMD='test'
, and this then allows special
builds that have $MAIN_CMD='pep8'
and $SETUP_CMD=''
.
Packages can also choose to not use the $MAIN_CMD
variable and instead to set the script
section to:
script:
- python setup.py $SETUP_CMD
and simply adjust $SETUP_CMD
as needed.
Following the set-up, if additional packages need to be installed, the
$CONDA_INSTALL
environment variable should be used to make sure that the
Python and Numpy versions stay fixed to those requested, e.g.
- $CONDA_INSTALL another_package
Include the following lines at the start of the install
section in appveyor.yml
:
install:
- "git clone git://github.com/astropy/ci-helpers.git"
- "powershell ci-helpers/appveyor/install-miniconda.ps1"
- "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
- "activate test"
This does the following:
- Set up Miniconda.
- Set up the PATH appropriately.
- Set up a conda environment named 'test' and switch to it.
- Set the
always_yes
config option for conda totrue
so that you don't need to include--yes
. - Register the specified channels, or if not stated the
astropy
,astropy-ci-extras
, andopenastronomy
channels.
Following this, various dependencies are installed depending on the following environment variables
-
$NUMPY_VERSION
: if set todev
ordevelopment
, the latest developer version of Numpy is installed along with Cython. If set to a version number, that version is installed. If set tostable
, install the latest stable version of Numpy. -
$ASTROPY_VERSION
: if set todev
ordevelopment
, the latest developer version of Astropy is installed, along with Cython and jinja2, which are compile-time dependencies. If set to a version number, that version is installed. If set tostable
, install the latest stable version of Astropy. If set tolts
the latest long term support (LTS) version is installed (more info about LTS can be found here. -
$CONDA_DEPENDENCIES
: this should be a space-separated string of package names that will be installed with conda. -
$CONDA_CHANNELS
: this should be a space-separated string of conda channel names, and defaults toastropy
,astropy-ci-extras
, andopenastronomy
.
The scripts include:
appveyor/install-miniconda.ps1
- set up conda on Windowsappveyor/windows_sdk.cmd
- set up the compiler environment on Windowstravis/setup_dependencies_common.sh
- set up conda packages on Linux and MacOS Xtravis/setup_conda_linux.sh
- set up conda on Linuxtravis/setup_conda_osx.sh
- set up conda on MacOS X
This repository can be cloned directly from the .travis.yml
and
appveyor.yml
files when about to run tests and does not need to be
included as a sub-module in repositories.