Skip to content

Commit

Permalink
fixed doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
mvberg committed Jan 16, 2021
1 parent 8d2ebc0 commit a3374e9
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion openfeed/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@

from .openfeed_client import OpenfeedClient

VERSION = '1.1.1'
VERSION = '1.1.2'
18 changes: 9 additions & 9 deletions openfeed/openfeed_client.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ def stop(self):
def add_heartbeat_subscription(self, callback):
"""Subscribe to [Heartbeat] messages (keep alive)
[Heartbeat]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Heartbeat]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.HeartBeat
"""
self.heartbeat_handlers.append(callback)

Expand All @@ -82,8 +82,8 @@ def add_symbol_subscription(self, symbol: Union[str, list], callback, service="R
subscription_type: list, optional
Default is ['QUOTE']. Can contain any of: 'ALL', 'QUOTE', 'QUOTE_PARTICIPANT', 'DEPTH_PRICE', 'DEPTH_ORDER', 'TRADES', 'OHLC'
[Market Data]: https://openfeed-org.github.io/documentation/Message%20Specification/
[SubscriptionTypes]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Market Data]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.MarketUpdate
[SubscriptionTypes]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.SubscriptionType
"""
symbols = []

Expand All @@ -110,7 +110,7 @@ def add_exchange_subscription(self, exchange: Union[str, list], callback, servic
Note: your credentials must have the correct service level (FEED) for this operation.
[Market Data]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Market Data]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.MarketUpdate
"""
exchanges = []

Expand Down Expand Up @@ -168,7 +168,7 @@ def request_instruments(self, callback, symbol=None, market_id=None, exchange=No
See [Instrument Request]
[Instrument Definitions]: https://openfeed-org.github.io/documentation/Message%20Specification/#openfeed_instrumentproto
[Instrument Definitions]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentDefinition
[Instrument Request]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentRequest
"""

Expand All @@ -186,22 +186,22 @@ def request_instruments(self, callback, symbol=None, market_id=None, exchange=No
def get_instrument_definitions(self):
"""Returns a dict of Openfeed [Instrument Definitions] keyed by MarketID
[Instrument Definitions]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Instrument Definitions]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentDefinition
"""
return self.instrument_definitions

def get_instrument_definition(self, id):
"""Returns an [Instrument Definition] for a Market ID
[Instrument Definition]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Instrument Definition]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentDefinition
"""
return self.instrument_definitions[id].instrumentDefinition

def get_instrument_definition_by_symbol(self, symbol):
"""Returns an [Instrument Definition] for a [Symbol] string
[Instrument Definition]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Symbol]: https://openfeed-org.github.io/documentation/Message%20Specification/
[Instrument Definition]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentDefinition
[Symbol]: https://openfeed-org.github.io/documentation/Message%20Specification/#org.openfeed.InstrumentDefinition.Symbol
"""
return self.instruments_by_symbol[symbol].instrumentDefinition

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "openfeed"
version = "1.1.1"
version = "1.1.2"
description = "Python SDK for Openfeed"
authors = ["Barchart <[email protected]>"]
license = "MIT"
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

setup(
name='openfeed',
version='1.1.1',
version='1.1.2',
author='Barchart',
author_email='[email protected]',
license='MIT',
Expand Down

0 comments on commit a3374e9

Please sign in to comment.