Readme bump

bar_select
Tyler Goodlet 2020-11-06 12:46:04 -05:00
parent c1109ee3fb
commit bdcee2b210
1 changed files with 47 additions and 40 deletions

View File

@ -2,15 +2,17 @@ piker
----- -----
trading gear for hackers. trading gear for hackers.
|travis| |gh_actions|
``piker`` is an attempt at a pro-grade, broker agnostic, next-gen FOSS .. |gh_actions| image:: https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fpikers%2Fpiker%2Fbadge&style=popout-square
toolset for real-time trading and financial analysis targetted at :target: https://actions-badge.atrox.dev/piker/pikers/goto
hardcore Linux users.
it tries to use as much bleeding edge tech as possible including (but not limited to): ``piker`` is a broker agnostic, next-gen FOSS toolset for real-time
trading targeted at hardcore Linux users.
- latest Python for glue_ and business logic we use as much bleeding edge tech as possible including (but not limited to):
- latest python for glue_
- 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
@ -32,23 +34,19 @@ it tries to use as much bleeding edge tech as possible including (but not limite
.. _fast numerics: https://zerowithdot.com/python-numpy-and-pandas-performance/ .. _fast numerics: https://zerowithdot.com/python-numpy-and-pandas-performance/
Focus and Features: focus and features:
******************* *******************
- zero web - zero web, cloud or "backtesting frameworks" (aka yabf)
- zero pump - zero self promotion (aka pump); expected throughout the community
- zero "backtesting" (aka yabf) - 100% federated: your code, your hardware, your data feeds, your broker fills
- zero "cloud" - broker/exchange/asset-class agnostic
- 100% federated: your code, your hardware, your broker's data feeds
- privacy - privacy
- broker/exchange agnostic - real-time financial signal processing from the ground up
- built on a structured concurrent actor model - high quality, attractive, native UX with expected use in tiling wms
- production grade, highly attractive native UIs - sophisticated rt charting and data sharing facilities
- expected to be used from tiling wms - geared for collaboration within trader communities
- sophisticated rt charting - zero interest in adoption by suits; no corporate friendly license, ever.
- emphasis on collaboration through UI and data sharing
- zero interest in adoption by suits
- not built for *sale*; built for *people* - not built for *sale*; built for *people*
- no corporate friendly license, ever.
fitting with these tenets, we're always open to new framework fitting with these tenets, we're always open to new framework
suggestions and ideas. suggestions and ideas.
@ -57,49 +55,58 @@ building the best looking, most reliable, keyboard friendly trading
platform is the dream. feel free to pipe in with your ideas and quiffs. platform is the dream. feel free to pipe in with your ideas and quiffs.
Install install
******* *******
``piker`` is currently under heavy pre-alpha development and as such should ``piker`` is currently under heavy pre-alpha development and as such
be cloned from this repo and hacked on directly. should 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
new components within `trio`_. new components within `trio`_.
For a development install:: for a development install::
git clone git@github.com:pikers/piker.git git clone git@github.com:pikers/piker.git
cd piker cd piker
pip install -e . pip install -e .
Broker Support broker Support
************** **************
For live data feeds the in-progress set of supported brokers is: for live data feeds the in-progress set of supported brokers is:
- Questrade_ which comes with effectively free L1
- IB_ via ``ib_insync`` - IB_ via ``ib_insync``
- Webull_ via the reverse engineered public API - questrade_ which comes with effectively free L1
- Kraken_ for crypto over their public websocket API - kraken_ for crypto over their public websocket API
If you want your broker supported and they have an API let us know. coming soon...
- webull_ via the reverse engineered public API
- yahoo via yliveticker_
- coinbase_ through websocket feed
if you want your broker supported and they have an API let us know.
.. _Questrade: https://www.questrade.com/api/documentation
.. _IB: https://interactivebrokers.github.io/tws-api/index.html .. _IB: https://interactivebrokers.github.io/tws-api/index.html
.. _Webull: https://www.kraken.com/features/api#public-market-data .. _questrade: https://www.questrade.com/api/documentation
.. _Kraken: https://www.kraken.com/features/api#public-market-data .. _kraken: https://www.kraken.com/features/api#public-market-data
.. _webull: https://github.com/tedchou12/webull
.. _yliveticker: https://github.com/yahoofinancelive/yliveticker
.. _coinbase: https://docs.pro.coinbase.com/#websocket-feed
check out our charts
Check out our charts
******************** ********************
bet you weren't expecting this from the foss bby:: bet you weren't expecting this from the foss bby::
piker -b kraken chart XBTUSD piker -b kraken chart XBTUSD
If anyone asks you what this project is about if anyone asks you what this project is about
********************************************* *********************************************
tell them *it's a broken crypto trading platform that doesn't scale*. you don't talk about it.
How do i get involved? how do i get involved?
********************** **********************
coming soon. enter the matrix.
learning the code is to your benefit and acts as a filter for desired
users; many alpha nuggets within.