document installation problem, use upstream urwidtrees (#129)

* document installation problem, use upstream urwidtrees

Fixes #128

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

* circle: install deps using only req.txt

Signed-off-by: Tomas Tomecek <ttomecek@redhat.com>

.travis.yml

@@ -4,7 +4,7 @@ python:
 - '3.4'
 - '3.5'
 install:
-- pip install urwid  # because urwidtrees is using urwid in setup.py
+- pip3 install git+https://github.com/pazz/urwidtrees.git@9142c59d3e41421ff6230708d08b6a134e0a8eed#egg=urwidtrees-1.0.3.dev
 - pip install -r requirements.txt
 - pip install -r requirements-test.txt
 script: py.test -vv tests

README.md

@@ -55,6 +55,15 @@ $ docker run -v /var/run/docker.sock:/run/docker.sock -ti -e TERM $USER/sen
 
 ## PyPI
 
+`sen` is using [`urwidtrees`](https://github.com/pazz/urwidtrees) as a dependency. Unfortunately, the upstream
+maintainer doesn't maintain it on PyPI so we need to install it directly from
+git, before installing sen (the forked PyPI version has a [bug](https://github.com/TomasTomecek/sen/issues/128) in
+installation process):
+
+```
+$ pip3 install git+https://github.com/pazz/urwidtrees.git@9142c59d3e41421ff6230708d08b6a134e0a8eed#egg=urwidtrees-1.0.3.dev
+```
+
 `sen` releases are available on PyPI:
 
 ```

circle.yml

@@ -6,8 +6,8 @@ machine:
 
 dependencies:
   pre:
-    - "pip3 install urwid"  # urwidtrees can't be installed via pip
-    - "pip3 install -r requirements-test.txt"
+    #    - "pip3 install git+https://github.com/pazz/urwidtrees.git@9142c59d3e41421ff6230708d08b6a134e0a8eed#egg=urwidtrees-1.0.3.dev"
+    #    - "pip3 install -r requirements-test.txt"
 
 test:
   pre:

requirements.txt

@@ -1,4 +1,5 @@
 urwid
 docker
-# this is 1.0.2, pazz doesn't maintain urwidtrees on PyPI
--e git://github.com/pazz/urwidtrees.git@b8159036521100c60ecaefdfe0bed4c50dc3ef23#egg=urwidtrees
+# this is latest upstream commit (April 2017)
+# upstream maintainer of urwidtrees doesn't maintain PyPI urwidtrees
+-e git+https://github.com/pazz/urwidtrees.git@9142c59d3e41421ff6230708d08b6a134e0a8eed#egg=urwidtrees

setup.py

@@ -4,10 +4,15 @@
 
 from setuptools import setup, find_packages
 
+# vcs+proto://host/path@revision#egg=project-version
+# this is latest upstream commit (April 2017)
+# upstream maintainer of urwidtrees doesn't maintain PyPI urwidtrees
+urwidtrees_source = "git+https://github.com/pazz/urwidtrees.git@9142c59d3e41421ff6230708d08b6a134e0a8eed#egg=urwidtrees-1.0.3.dev"
+
 requirements = [
     "urwid",
-    "urwidtrees",
-    "docker"
+    "docker",
+    "urwidtrees"
 ]
 
 setup(
@@ -23,6 +28,7 @@
     },
     packages=find_packages(exclude=["*.tests", "*.tests.*", "tests.*", "tests"]),
     install_requires=requirements,
+    dependency_links=[urwidtrees_source],
     classifiers=['Development Status :: 5 - Production/Stable',
                  'Intended Audience :: Developers',
                  'Intended Audience :: System Administrators',