Skip to content

Commit 28b8fb5

Browse files
committed
[EN-1328] print results added
1 parent 5c7ebbf commit 28b8fb5

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

docs/basic_usage.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ e.g. connection address or status
2828
print(f'Connected address: {endpoint.address}')
2929
print(f'Connection status: {endpoint.connection_status}')
3030
31+
.. code:: text
32+
33+
demo.dxfeed.com:7300
34+
Connected and authorized
35+
3136
Configure and create subscription
3237
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3338

@@ -48,7 +53,7 @@ you should also provide time to start subscription from.
4853

4954
.. code:: ipython3
5055
51-
trade_sub = trade_sub.add_symbols(['C', 'TSLA'])
56+
trade_sub = trade_sub.add_symbols(['C', 'AAPL'])
5257
5358
For timed subscription you may provide either datetime object or string.
5459
String might be incomlete, in this case you will get warning with how
@@ -74,6 +79,11 @@ Subscription instance properties
7479
print(f'Subscription event type: {tns_sub.event_type}')
7580
print(f'Subscription symbols: {candle_sub.symbols}')
7681
82+
.. code:: text
83+
84+
TimeAndSale
85+
['AAPL', 'MSFT']
86+
7787
Access data
7888
~~~~~~~~~~~
7989

@@ -85,15 +95,6 @@ extracts all data recieved to the moment and clears the buffer in class.
8595
8696
candle_sub.get_data()
8797
88-
Detach listener
89-
~~~~~~~~~~~~~~~
90-
91-
.. code:: ipython3
92-
93-
trade_sub.detach_listener()
94-
tns_sub.detach_listener()
95-
candle_sub.detach_listener();
96-
9798
Close connection
9899
~~~~~~~~~~~~~~~~
99100

@@ -102,20 +103,15 @@ Close connection
102103
endpoint.close_connection()
103104
print(f'Connection status: {endpoint.connection_status}')
104105
106+
.. code:: text
107+
108+
Not connected
109+
105110
Transform data to pandas DataFrame
106111
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
107112

108113
.. code:: ipython3
109114
110115
trade_df = trade_sub.to_dataframe()
111-
trade_df.head()
112-
113-
.. code:: ipython3
114-
115116
tns_df = tns_sub.to_dataframe()
116-
tns_df.head()
117-
118-
.. code:: ipython3
119-
120117
candle_df = candle_sub.to_dataframe()
121-
candle_df.head()

0 commit comments

Comments
 (0)