piker/README.rst

106 lines
3.3 KiB
ReStructuredText
Raw Normal View History

2018-01-20 18:19:15 +00:00
piker
2018-02-15 18:33:53 +00:00
-----
2020-09-02 16:36:24 +00:00
trading gear for hackers.
2018-01-27 06:52:24 +00:00
2019-03-22 02:46:20 +00:00
|travis|
2018-04-11 04:10:45 +00:00
2020-09-02 16:36:24 +00:00
``piker`` is an attempt at a pro-grade, broker agnostic, next-gen FOSS
toolset for real-time trading and financial analysis targetted at
hardcore Linux users.
2019-02-26 06:14:58 +00:00
2020-09-02 16:36:24 +00:00
it tries to use as much bleeding edge tech as possible including (but not limited to):
2019-02-26 06:14:58 +00:00
2020-09-02 16:36:24 +00:00
- latest Python for glue_ and business logic
- trio_ for `structured concurrency`_
2020-07-08 19:42:51 +00:00
- tractor_ for distributed, multi-core, real-time streaming
2020-06-02 14:32:04 +00:00
- marketstore_ for historical and real-time tick data persistence and sharing
- techtonicdb_ for L2 book storage
2020-05-12 02:43:30 +00:00
- Qt_ for pristine high performance UIs
2020-07-08 19:42:51 +00:00
- pyqtgraph_ for real-time charting
2020-09-02 16:36:24 +00:00
- ``numpy`` and ``numba`` for `fast numerics`_
2019-02-26 06:14:58 +00:00
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
2019-03-22 02:46:20 +00:00
.. _trio: https://github.com/python-trio/trio
.. _tractor: https://github.com/goodboy/tractor
2020-09-02 16:45:24 +00:00
.. _structured concurrency: https://trio.discourse.group/
2020-05-12 02:43:30 +00:00
.. _marketstore: https://github.com/alpacahq/marketstore
2020-06-02 14:32:04 +00:00
.. _techtonicdb: https://github.com/0b01/tectonicdb
2020-05-12 02:43:30 +00:00
.. _Qt: https://www.qt.io/
2020-09-02 16:45:24 +00:00
.. _pyqtgraph: https://github.com/pyqtgraph/pyqtgraph
2020-06-03 16:09:55 +00:00
.. _glue: https://numpy.org/doc/stable/user/c-info.python-as-glue.html#using-python-as-glue
2020-07-08 19:42:51 +00:00
.. _fast numerics: https://zerowithdot.com/python-numpy-and-pandas-performance/
2019-03-22 02:46:20 +00:00
2020-05-12 02:43:30 +00:00
Focus and Features:
*******************
2020-09-02 16:36:24 +00:00
- zero web
- zero pump
- zero "backtesting" (aka yabf)
- zero "cloud"
- 100% federated: your code, your hardware, your broker's data feeds
- privacy
- broker/exchange agnostic
2020-09-02 16:45:24 +00:00
- built on a structured concurrent actor model
2020-09-02 16:36:24 +00:00
- production grade, highly attractive native UIs
- expected to be used from tiling wms
- sophisticated rt charting
- emphasis on collaboration through UI and data sharing
- zero interest in adoption by suits
- not built for *sale*; built for *people*
- no corporate friendly license, ever.
2020-09-02 16:45:24 +00:00
fitting with these tenets, we're always open to new framework
suggestions and ideas.
2020-09-02 16:36:24 +00:00
2020-09-02 16:45:24 +00:00
building the best looking, most reliable, keyboard friendly trading
platform is the dream. feel free to pipe in with your ideas and quiffs.
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
*******
2019-03-22 02:46:20 +00:00
``piker`` is currently under heavy pre-alpha development and as such should
2018-01-27 06:52:24 +00:00
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
2020-07-08 19:42:51 +00:00
new components within `trio`_.
2019-04-30 17:19:04 +00:00
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
2020-09-02 16:45:24 +00:00
pip install -e .
2018-02-12 15:55:04 +00:00
2019-03-22 02:46:20 +00:00
Broker Support
**************
2020-09-02 16:36:24 +00:00
For live data feeds the in-progress set of supported brokers is:
2020-07-08 19:42:51 +00:00
- Questrade_ which comes with effectively free L1
2020-09-02 16:36:24 +00:00
- IB_ via ``ib_insync``
2020-07-08 19:42:51 +00:00
- Webull_ via the reverse engineered public API
- Kraken_ for crypto over their public websocket API
2019-03-22 02:46:20 +00:00
If you want your broker supported and they have an API let us know.
.. _Questrade: https://www.questrade.com/api/documentation
2020-07-08 19:42:51 +00:00
.. _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
2019-03-22 02:46:20 +00:00
2020-09-02 16:36:24 +00:00
Check out our charts
********************
bet you weren't expecting this from the foss bby::
2018-04-18 18:03:59 +00:00
2020-10-15 18:30:48 +00:00
piker -b kraken chart XBTUSD
2018-04-18 18:03:59 +00:00
2020-09-02 16:36:24 +00:00
If anyone asks you what this project is about
*********************************************
tell them *it's a broken crypto trading platform that doesn't scale*.
2018-04-18 18:03:59 +00:00
2020-09-02 16:36:24 +00:00
How do i get involved?
**********************
coming soon.