fugle-realtime 0.2.0

Fugle Realtime

fugle-realtime-py

Fugle Realtime Python

Documentation

https://developer.fugle.tw/realtime

Installation

pip install fugle-realtime

Usage

from fugle_realtime import intraday

intraday.chart: https://api.fugle.tw/realtime/v0/intraday/chart

intraday.chart(apiToken="demo", output="dataframe", symbolId="2884")

intraday.meta: https://api.fugle.tw/realtime/v0/intraday/meta

intraday.meta(apiToken="demo", output="dataframe", symbolId="2884")

intraday.quote: https://api.fugle.tw/realtime/v0/intraday/quote

intraday.quote(apiToken="demo", output="dataframe", symbolId="2884")

intraday.trades: https://api.fugle.tw/realtime/v0/intraday/trades

intraday.trades(apiToken="demo", output="dataframe", symbolId="2884")

output="dataframe" will return pandas DataFrame, which is the default. output="raw" will return python built-in dict or list accordingly.

symbolId="2884" is only allowed when apiToken="demo". To access more symbolId, you will have to get your own apiToken. Please visit https://developer.fugle.tw/realtime/apiToken for detailed instructions.

For complete documentation of each URL and its parameters in association with the corresponding function and its arguments specified above, please visit https://developer.fugle.tw/realtime/document.

Contributing

Git clone the repository:

git clone https://github.com/fortuna-intelligence/fugle-realtime-py.git
cd fugle-realtime-py

Install poetry if not yet installed:

curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python

Then install dependencies and setup pre-commit:

poetry install
poetry run pre-commit install

Code formatting using black:

poetry run black .

Testing using pytest:

poetry run pytest

Publishing

PyPI: fugle-realtime

poetry publish --build --repository pypi --username username --password password