diff --git a/README.rst b/README.rst index 42f0f2cc..5a5107e3 100644 --- a/README.rst +++ b/README.rst @@ -8,6 +8,24 @@ Install ``piker`` is currently under heavy alpha development and as such should be cloned from this repo and hacked on directly. +A couple very alpha components are being used atm pertaining to +async ports of libraries for use with ``trio``. + +Before installing make sure you have ``pip`` and ``virtualenv``. + +Then for a development install:: + + $ git clone git@github.com:pikers/piker.git + $ cd piker + $ virtualenv env + $ source ./env/bin/activate + (env) $ pip install cython + (env) $ pip install -e ./ -r requirements.txt + +To start the real-time watchlist:: + + (env) $ piker watch cannabis + If you insist on trying to install it (which should work) please do it from this GitHub repository:: diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..26f8be53 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +# matham's next-gen async port of kivy +git+git://github.com/matham/kivy.git@async-loop diff --git a/setup.py b/setup.py index 71b5ed49..07d86eb4 100755 --- a/setup.py +++ b/setup.py @@ -35,7 +35,8 @@ setup( }, install_requires=[ 'click', 'colorlog', 'trio', 'attrs', 'async_generator', - 'pygments', 'cython', 'kivy', 'asks', 'pandas', + 'pygments', 'cython', 'asks', 'pandas', + #'kivy', see requirement.txt; using a custom branch atm ], extras_require={ 'questrade': ['asks'],