Release instructions

How to make a new release of param

(Note: these instructions don't appear to have been updated to match what was actually done for recent releases...)

• [Insert important tasks such as review commit log, update release notes, etc!]

• In param/__init__.py, update the release tuple to (A,B,C) and commit:

  git commit -m "Release vA.B.C"
  

• Add the version number as a tag in git:

  git tag -a vA.B.C -m "Release vA.B.C"
  

• Push the tag to github:

  git push --tags origin master
  

• Test creation of sdist and that it's got all the right stuff in it:

  python setup.py sdist
  cd dist; tar xvf param-A.B.C.tar.gz
  

• Publish on PyPi:

  python setup.py sdist register upload
  

• Check you can download and python setup.py install into a virtual env, try pip install, try pip install --upgrade etc...

• [Insert important tasks such as update webpage...]

• Publish Windows exe files on PyPi (from a Windows machine):

  (ensure git is available in your console)
  python setup.py bdist_wininst --plat-name=win32 --user-access-control=auto upload
  python setup.py bdist_wininst --plat-name=win-amd64 --user-access-control=auto upload
  

• Check you can download and run the exe, that param installs ok and you can use it, etc...

• Publish conda package; notes below...

conda install -c ioam param

build.sh:

#!/bin/bash
$PYTHON setup.py install

meta.yaml:

package:
  name: param
  version: 1.4.1

source:
  path: .

requirements:
  build:
    - python
    - setuptools
  run:
    - python

test:
  imports:
    - param

about:
  home: http://ioam.github.io/param/
  summary: Make your Python code clearer and more reliable by declaring Parameters
  license: BSD