Drop kivy stuff from docs

its_happening
Tyler Goodlet 2020-07-08 15:42:51 -04:00
parent 5d0f4bf112
commit 93fed5ec28
1 changed files with 23 additions and 38 deletions

View File

@ -10,11 +10,13 @@ trading and financial analysis targetted at hardcore Linux users.
It tries to use as much bleeding edge tech as possible including (but not limited to): It tries to use as much bleeding edge tech as possible including (but not limited to):
- Python 3.7+ for glue_ and business logic - Python 3.7+ for glue_ and business logic
- trio_ for async - trio_ for structured concurrency
- tractor_ as the underlying actor model - tractor_ for distributed, multi-core, real-time streaming
- marketstore_ for historical and real-time tick data persistence and sharing - marketstore_ for historical and real-time tick data persistence and sharing
- techtonicdb_ for L2 book storage - techtonicdb_ for L2 book storage
- Qt_ for pristine high performance UIs - Qt_ for pristine high performance UIs
- pyqtgraph_ for real-time charting
- ``numpy`` for `fast numerics`_
.. |travis| image:: https://img.shields.io/travis/pikers/piker/master.svg .. |travis| image:: https://img.shields.io/travis/pikers/piker/master.svg
:target: https://travis-ci.org/pikers/piker :target: https://travis-ci.org/pikers/piker
@ -24,6 +26,7 @@ It tries to use as much bleeding edge tech as possible including (but not limite
.. _techtonicdb: https://github.com/0b01/tectonicdb .. _techtonicdb: https://github.com/0b01/tectonicdb
.. _Qt: https://www.qt.io/ .. _Qt: https://www.qt.io/
.. _glue: https://numpy.org/doc/stable/user/c-info.python-as-glue.html#using-python-as-glue .. _glue: https://numpy.org/doc/stable/user/c-info.python-as-glue.html#using-python-as-glue
.. _fast numerics: https://zerowithdot.com/python-numpy-and-pandas-performance/
Focus and Features: Focus and Features:
@ -65,27 +68,7 @@ Install
be cloned from this repo and hacked on directly. be cloned from this repo and hacked on directly.
A couple bleeding edge components are being used atm pertaining to A couple bleeding edge components are being used atm pertaining to
async ports of libraries for use with `trio`_. new components within `trio`_.
Before installing make sure you have `pipenv`_ and have installed
``python3.7`` as well as `kivy source build`_ dependencies
since currently there's reliance on an async development branch.
`kivy` dependencies
===================
On Archlinux you need the following dependencies::
pacman -S python-docutils gstreamer sdl2_ttf sdl2_mixer sdl2_image xclip
To manually install the async branch of ``kivy`` from github do (though
this should be done as part of the ``pipenv install`` below)::
pipenv install -e 'git+git://github.com/matham/kivy.git@async-loop#egg=kivy'
.. _kivy source build:
https://kivy.org/docs/installation/installation-linux.html#installation-in-a-virtual-environment
For a development install:: For a development install::
@ -97,34 +80,36 @@ For a development install::
Broker Support Broker Support
************** **************
For live data feeds the only fully functional broker at the moment is Questrade_. For live data feeds the set of supported brokers is:
Eventual support is in the works for `IB`, `TD Ameritrade` and `IEX`. - Questrade_ which comes with effectively free L1
- IB_ via ib_insync
- Webull_ via the reverse engineered public API
- Kraken_ for crypto over their public websocket API
If you want your broker supported and they have an API let us know. If you want your broker supported and they have an API let us know.
.. _Questrade: https://www.questrade.com/api/documentation .. _Questrade: https://www.questrade.com/api/documentation
.. _IB: https://interactivebrokers.github.io/tws-api/index.html
.. _Webull: https://www.kraken.com/features/api#public-market-data
.. _Kraken: https://www.kraken.com/features/api#public-market-data
Play with some UIs Check out some charts
****************** *********************
Bet you weren't expecting this from the foss::
To start the real-time index monitor with the `questrade` backend:: piker chart spy.arca
piker -l info monitor indexes
If you want to see super granular price changes, increase the It is also possible to run a specific broker's data feed as a top
broker quote query ``rate`` with ``-r``:: level micro-service daemon::
piker monitor indexes -r 10 pikerd -l info -b ib
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:: Then start the client app as normal::
piker monitor indexes piker chart -b ib ES.GLOBEX
.. _pipenv: https://docs.pipenv.org/ .. _pipenv: https://docs.pipenv.org/