diff --git a/README.rst b/README.rst index f75b67b2..d18f15ed 100644 --- a/README.rst +++ b/README.rst @@ -4,9 +4,19 @@ Trading gear for hackers. |pypi| |travis| |versions| |license| |docs| +``piker`` is an attempt at a pro-grade, broker agnostic, next-gen FOSS toolset for real-time +trading and financial analysis. + +It tries to use as much cutting edge tech as possible including (but not limited to): + +- Python 3.7+ +- ``trio`` +- ``tractor`` + .. |travis| image:: https://img.shields.io/travis/pikers/piker/master.svg :target: https://travis-ci.org/pikers/piker + Install ******* ``piker`` is currently under heavy alpha development and as such should @@ -25,43 +35,33 @@ For a development install:: To start the real-time index ETF watchlist with the `robinhood` backend:: - piker watch indexes -l info + piker -l info monitor indexes If you want to see super granular price changes, increase the broker quote query ``rate`` with ``-r``:: - piker watch indexes -l info -r 10 + piker monitor indexes -r 10 -It is also possible to run the broker-client micro service as a daemon:: +It is also possible to run the broker data feed micro service as a daemon:: pikerd -l info Then start the client app as normal:: - piker watch indexes -l info + piker monitor indexes .. _trio: https://github.com/python-trio/trio .. _pipenv: https://docs.pipenv.org/ -Laggy distros -============= + +Finicky dependencies +==================== For those running pop-culture distros that don't yet ship ``python3.7`` you'll need to install it as well as `kivy source build`_ dependencies since currently there's reliance on an async development branch. .. _kivy source build: https://kivy.org/docs/installation/installation-linux.html#installation-in-a-virtual-environment - -Tech -**** -``piker`` is an attempt at a pro-grade, next-gen open source toolset -for real-time trading and financial analysis. - -It tries to use as much cutting edge tech as possible including (but not limited to): - -- Python 3.7+ -- ``trio`` -- ``tractor``