From d6772d16e7c16c7bc72d866093f9d39704909df9 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Fri, 23 Jan 2015 10:11:10 -0800 Subject: [PATCH] Updating README to point to PyPI and adding Travis config. Travis config will deploy to PyPI on a new tag. --- .travis.yml | 13 +++++++++++++ README.md | 17 +++++++++++++---- 2 files changed, 26 insertions(+), 4 deletions(-) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..3464c9a --- /dev/null +++ b/.travis.yml @@ -0,0 +1,13 @@ +language: python +sudo: false + +deploy: + provider: pypi + user: foo + password: + secure: bar + on: + tags: true + repo: arokem/python-matlab-bridge + # until this is fixed: https://github.com/travis-ci/travis-ci/issues/1675 + all_branches: true diff --git a/README.md b/README.md index 5c669c7..3f84b3e 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,21 @@ Matlab code together (requires ipython > 0.13). ## Installation -Pymatbridge communicates with Matlab using zeromq. So before installing +`pymatbridge` can be installed from [PyPI][1]: + +``` +$ pip install pymatbridge # sudo may be needed +``` + +`pymatbridge` communicates with Matlab using zeromq. So before installing pymatbridge you must have [zmq](http://zeromq.org/intro:get-the-software) library and [pyzmq](http://zeromq.org/bindings:python) installed on your machine. If you intend to use the Matlab magic extension, you'll also need -[IPython](http://ipython.org/install.html). To make pymatbridge work properly, -please follow the following steps. +[IPython](http://ipython.org/install.html). Note that IPython notebooks +also depend on `pyzmq` so if you have IPython notebooks installed, you likely +have `pyzmq` already. + +To make pymatbridge work properly, please follow the following steps. ### Install zmq library Please refer to the [official guide](http://zeromq.org/intro:get-the-software) on how to @@ -207,4 +216,4 @@ Python communicates with Matlab via an ad-hoc zmq messenger. This is inherently insecure, as the Matlab instance may be directed to perform arbitrary system calls. There is no sandboxing of any kind. Use this code at your own risk. - +[1]: https://pypi.python.org/pypi/pymatbridge