From d6772d16e7c16c7bc72d866093f9d39704909df9 Mon Sep 17 00:00:00 2001 From: Danny Hermes Date: Fri, 23 Jan 2015 10:11:10 -0800 Subject: [PATCH 1/3] 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 From d48892eeb61a56a6d9831acf072f8da9c301b8be Mon Sep 17 00:00:00 2001 From: arokem Date: Sat, 24 Jan 2015 13:26:56 -0800 Subject: [PATCH 2/3] Added pypi credentials. --- .travis.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.travis.yml b/.travis.yml index 3464c9a..378be66 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,11 +1,10 @@ language: python sudo: false - deploy: provider: pypi - user: foo + user: arokem password: - secure: bar + secure: AB7BnrkNOTQWXUNiaShedbIEBay+5JbulAxUHY4vEMdiI68bPLYOrIDxuT/lIfWrrgXUuicbJcWUxt6zpdUEQrEfYB6pNhrosZv4+R5HZu1FHY7EfOfsyHxb2wnezKuIEVXdevAmIg5rYNeTPcdl/CFm4xQGfdc4a3eyT5cJT58= on: tags: true repo: arokem/python-matlab-bridge From 0423916772e04809b3b7cc40a96e470b092d2064 Mon Sep 17 00:00:00 2001 From: arokem Date: Sat, 24 Jan 2015 14:54:57 -0800 Subject: [PATCH 3/3] Will this make travis happy(er)? --- .travis.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.travis.yml b/.travis.yml index 378be66..9d099c3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -10,3 +10,5 @@ deploy: repo: arokem/python-matlab-bridge # until this is fixed: https://github.com/travis-ci/travis-ci/issues/1675 all_branches: true +script: + - true