Add note about Pipsi to installation

svieira commented 8 years ago

Pipsi makes installing Python scripts better by automating the creation and management of virtual environments for Python-backed scripts

codecov-io commented 8 years ago

Current coverage is `95.76%`

Merging #44 into master will not affect coverage as of 5d5c78f

@@            master     #44   diff @@
======================================
  Files           22      22       
  Stmts         1133    1133       
  Branches         0       0       
  Methods          0       0       
======================================
  Hit           1085    1085       
  Partial          0       0       
  Missed          48      48

Review entire Coverage Diff as of 5d5c78f

Powered by Codecov. Updated on successful CI builds.

donnemartin commented 8 years ago

@svieira thanks for the pull request and the tip about pipsi. I took a look and it seems like a cool project, although it doesn't seem to have Windows support. What do you think about this tweak to your pull request?

Installation

...

Virtual Environment Installation

It is recommended that you install Python packages in a virtualenv to avoid potential issues with dependencies or permissions.

If you are a Windows user or if you would like more details on virtualenv, check out this guide.

Install virtualenv and virtualenvwrapper, or check out the Pipsi Installation section below:

pip install virtualenv
pip install virtualenvwrapper
export WORKON_HOME=~/.virtualenvs
source /usr/local/bin/virtualenvwrapper.sh

Create a SAWS virtualenv and install SAWS:

mkvirtualenv saws
pip install saws

If you want to activate the saws virtualenv again later, run:

workon saws

Pipsi Installation

Pipsi simplifies virtualenv installation.

Install pipsi:

pip install pipsi

Create a virtualenv and install SAWS:

pipsi install saws

For Python 3:

pipsi install --python=python3 saws

Note: Pipsi is not supported on Windows.

AWS Credentials and Named Profiles

...

svieira commented 8 years ago

I'm glad I could introduce you to it!

As I understand it, Pipsi supports Windows too (and looking at the source code it seems to support it), so I left that out of my update.

But otherwise, it's been updated. Let me know what you think!

donnemartin commented 8 years ago

@svieira great, I'll merge this, thanks for the pull request. The issue tracker for pipsi shows a couple bugs about it not working on Windows, though I haven't checked myself.

https://github.com/mitsuhiko/pipsi/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+windows

donnemartin / saws