piker/README.rst

68 lines
1.7 KiB
ReStructuredText
Raw Normal View History

2018-01-20 18:19:15 +00:00
piker
2018-02-15 18:33:53 +00:00
-----
2018-11-23 16:04:21 +00:00
Trading gear for hackers.
2018-01-27 06:52:24 +00:00
2018-04-11 04:10:45 +00:00
|pypi| |travis| |versions| |license| |docs|
2019-02-26 06:14:58 +00:00
``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``
2018-04-11 04:10:45 +00:00
.. |travis| image:: https://img.shields.io/travis/pikers/piker/master.svg
:target: https://travis-ci.org/pikers/piker
2018-01-27 06:52:24 +00:00
2019-02-26 06:14:58 +00:00
2018-01-27 06:52:24 +00:00
Install
*******
``piker`` is currently under heavy alpha development and as such should
be cloned from this repo and hacked on directly.
2018-02-15 18:33:53 +00:00
A couple bleeding edge components are being used atm pertaining to
async ports of libraries for use with `trio`_.
2018-02-12 15:55:04 +00:00
2018-03-28 19:22:39 +00:00
Before installing make sure you have `pipenv`_.
2018-02-15 18:33:53 +00:00
For a development install::
2018-02-12 15:55:04 +00:00
git clone git@github.com:pikers/piker.git
cd piker
2018-03-28 19:22:39 +00:00
pipenv install --dev -e .
pipenv shell
2018-02-12 15:55:04 +00:00
2019-03-03 16:02:06 +00:00
To start the real-time index ETF watchlist with the `questrade` backend::
2018-02-12 15:55:04 +00:00
2019-02-26 06:14:58 +00:00
piker -l info monitor indexes
2018-03-21 21:32:32 +00:00
If you want to see super granular price changes, increase the
broker quote query ``rate`` with ``-r``::
2019-02-26 06:14:58 +00:00
piker monitor indexes -r 10
2018-02-12 15:55:04 +00:00
2018-01-27 06:52:24 +00:00
2019-02-26 06:14:58 +00:00
It is also possible to run the broker data feed micro service as a daemon::
2018-04-18 18:03:59 +00:00
pikerd -l info
Then start the client app as normal::
2019-02-26 06:14:58 +00:00
piker monitor indexes
2018-04-18 18:03:59 +00:00
2018-02-15 18:33:53 +00:00
.. _trio: https://github.com/python-trio/trio
2018-03-28 19:22:39 +00:00
.. _pipenv: https://docs.pipenv.org/
2018-02-15 18:33:53 +00:00
2019-02-26 06:14:58 +00:00
Finicky dependencies
====================
2018-11-23 16:04:21 +00:00
For those running pop-culture distros that don't yet ship ``python3.7``
2018-02-15 18:33:53 +00:00
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