better readme

bar_select
Tyler Goodlet 2020-09-02 12:36:24 -04:00
parent 0e513599eb
commit 48c70e8ae4
1 changed files with 40 additions and 51 deletions

View File

@ -1,26 +1,28 @@
piker piker
----- -----
Trading gear for hackers. trading gear for hackers.
|travis| |travis|
``piker`` is an attempt at a pro-grade, broker agnostic, next-gen FOSS toolset for real-time ``piker`` is an attempt at a pro-grade, broker agnostic, next-gen FOSS
trading and financial analysis targetted at hardcore Linux users. toolset for real-time 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 - latest Python for glue_ and business logic
- trio_ for structured concurrency - trio_ for `structured concurrency`_
- tractor_ for distributed, multi-core, real-time streaming - 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 - pyqtgraph_ for real-time charting
- ``numpy`` for `fast numerics`_ - ``numpy`` and ``numba`` 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
.. _trio: https://github.com/python-trio/trio .. _trio: https://github.com/python-trio/trio
.. _structured concurrency: https://trio.discourse.group/
.. _tractor: https://github.com/goodboy/tractor .. _tractor: https://github.com/goodboy/tractor
.. _marketstore: https://github.com/alpacahq/marketstore .. _marketstore: https://github.com/alpacahq/marketstore
.. _techtonicdb: https://github.com/0b01/tectonicdb .. _techtonicdb: https://github.com/0b01/tectonicdb
@ -31,35 +33,26 @@ It tries to use as much bleeding edge tech as possible including (but not limite
Focus and Features: Focus and Features:
******************* *******************
- 100% federated: running your code on your hardware with your - zero web
broker's data feeds, privately, **is the point** (this is not a web-based *I - zero pump
don't know how to run my own system* project). - zero "backtesting" (aka yabf)
- Asset class, broker, exchange agnostic. - zero "cloud"
- Built on a highly reliable `structured concurrent actor model - 100% federated: your code, your hardware, your broker's data feeds
<tractor>`_ with built in async streaming and scalability protocols - privacy
allowing for a distributed architecture from the ground up. - broker/exchange agnostic
- Privacy: your orders, indicators, algos are all run client side and - built on a `structured concurrent actor model <tractor>`_
are shared only with the (groups of) traders you specify. - production grade, highly attractive native UIs
- Production grade, highly attractive native UIs that feel and fit like - expected to be used from tiling wms
a proper pair of skinny jeans; only meant to be used with a proper - sophisticated rt charting
tiling window manager (no, we are not ignorant enough to roll our own). - emphasis on collaboration through UI and data sharing
- Sophisticated charting capable of processing large data sets in real-time - zero interest in adoption by suits
while sanely displaying complex models and strategy systems. - not built for *sale*; built for *people*
- Built-in support for *hipstery* indicators and studies that you - no corporate friendly license, ever.
probably haven't heard of but that the authors **know** generate alpha
when paired with the right strategies.
- Emphasis on collaboration through sharing of data, ideas, and processing
power. We will not host your code in the cloud nor ask you to
participate in any lame "alpha competitions".
- Adoption is very low priority, especially if you're not an experienced
trader; the system is not built for sale it is built for *people*.
- No, we will never have a "corporation friendly license"; if you intend to use
this code base we must know about it.
Fitting with these tenets, we're always open to new framework suggestions and ideas. fitting with these tenets, we're always open to new framework suggestions and ideas.
Building the best looking, most reliable, keyboard friendly trading platform is the dream. building the best looking, most reliable, keyboard friendly trading platform is the dream.
Feel free to pipe in with your ideas and quiffs. feel free to pipe in with your ideas and quiffs.
Install Install
@ -80,9 +73,10 @@ For a development install::
Broker Support Broker Support
************** **************
For live data feeds the set of supported brokers is: For live data feeds the in-progress set of supported brokers is:
- Questrade_ which comes with effectively free L1 - Questrade_ which comes with effectively free L1
- IB_ via ib_insync - IB_ via ``ib_insync``
- Webull_ via the reverse engineered public API - Webull_ via the reverse engineered public API
- Kraken_ for crypto over their public websocket API - Kraken_ for crypto over their public websocket API
@ -94,22 +88,17 @@ If you want your broker supported and they have an API let us know.
.. _Kraken: https://www.kraken.com/features/api#public-market-data .. _Kraken: https://www.kraken.com/features/api#public-market-data
Check out some charts Check out our charts
********************* ********************
Bet you weren't expecting this from the foss:: bet you weren't expecting this from the foss bby::
piker chart spy.arca piker chart -b kraken XBTUSD
It is also possible to run a specific broker's data feed as a top If anyone asks you what this project is about
level micro-service daemon:: *********************************************
tell them *it's a broken crypto trading platform that doesn't scale*.
pikerd -l info -b ib How do i get involved?
**********************
coming soon.
Then start the client app as normal::
piker chart -b ib ES.GLOBEX
.. _pipenv: https://docs.pipenv.org/