Skip to content

Commit 735a4e0

Browse files
committed
Added Readme and b5 session and other interface related changes.
1 parent 8c9c397 commit 735a4e0

File tree

9 files changed

+2171
-2241
lines changed

9 files changed

+2171
-2241
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,3 +135,4 @@ Configuration/refinitiv-data.config.json
135135
Configuration/refinitiv-data.config.json
136136
Configuration/refinitiv-data.config.json
137137
Configuration/refinitiv-data.config.json
138+
Configuration/refinitiv-data.config.json

Quick Start/QS_1.0 - Sessions.ipynb

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,10 @@
2929
"For ease of use, you can set various initialization parameters of the RD Library in the **_refinitiv-data.config.json_** configuration file - as detailed in the next section below.\n",
3030
"\n",
3131
"Typically you may place this file in the same folder as your Notebook or Python script.\n",
32-
"Alternatively, you can place the file in an folder of your choice and specify the location using the _RD_LIB_CONFIG_PATH_ environment variable. \n",
32+
"OR, you can place the file in an alternative folder and specify the folder path using the _RD_LIB_CONFIG_PATH_ environment variable. \n",
3333
"\n",
34-
"As these tutorial Notebooks are in Categorised sub-folders and to avoid the need for multiple config files (in each sub-folder), we will use the _RD_LIB_CONFIG_PATH_ environment variable to point to a single instance of the config file in the top-level ***Configuration*** folder.\n",
34+
"### One config file for the tutorials\n",
35+
"As these tutorial Notebooks are categorised into sub-folders and to avoid the need for multiple config files, we will use the _RD_LIB_CONFIG_PATH_ environment variable to point to a single instance of the config file in the top-level ***Configuration*** folder.\n",
3536
"\n",
3637
"Before proceeding, please **ensure you have entered your credentials** into the config file in the ***Configuration*** folder."
3738
]
@@ -157,6 +158,28 @@
157158
"rd.open_session(config_name=\"../Configuration/refinitiv-data.custom.config.json\")"
158159
]
159160
},
161+
{
162+
"cell_type": "markdown",
163+
"id": "c840ae9a-438b-4d89-b6ad-3d98e62eed87",
164+
"metadata": {},
165+
"source": [
166+
"#### Close the default session \n",
167+
"\n",
168+
"To close the default session you can call:"
169+
]
170+
},
171+
{
172+
"cell_type": "code",
173+
"execution_count": null,
174+
"id": "31806e10-6589-4d2f-842b-2319a67f311c",
175+
"metadata": {
176+
"tags": []
177+
},
178+
"outputs": [],
179+
"source": [
180+
"rd.close_session()"
181+
]
182+
},
160183
{
161184
"cell_type": "markdown",
162185
"id": "079c0ec3",
@@ -190,9 +213,9 @@
190213
"id": "3b0f1e3f-c16f-4618-87be-ee422b7a50e1",
191214
"metadata": {},
192215
"source": [
193-
"\n",
194-
"However, if you choose not use the refinitiv-data config file - rather than hardcoding parameters in your code, you may prefer to keep your credentials in a .env file (or some other external store) - to avoid accidentally exposing your credentials when sharing code. \n",
195-
"A empty .env file has been included in this ***Quick Start*** folder.\n"
216+
" \n",
217+
"However, rather than hardcoding parameters in your code, you may prefer to keep your credentials in a .env file (or some other external store) - to avoid accidentally exposing your credentials when sharing code. \n",
218+
"A .env file with blank entries has been included in this ***Quick Start*** folder - for your reference.\n"
196219
]
197220
},
198221
{
@@ -373,7 +396,7 @@
373396
},
374397
{
375398
"cell_type": "markdown",
376-
"id": "8b12fc65",
399+
"id": "014c7989-9859-4de2-98fa-9d912aad1636",
377400
"metadata": {},
378401
"source": [
379402
"## Session Events and State change notification\n",
@@ -425,14 +448,6 @@
425448
"# close the session when done\n",
426449
"session.close()"
427450
]
428-
},
429-
{
430-
"cell_type": "code",
431-
"execution_count": null,
432-
"id": "8119442c-31d2-436c-a2ab-4200700fb248",
433-
"metadata": {},
434-
"outputs": [],
435-
"source": []
436451
}
437452
],
438453
"metadata": {

Quick Start/README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Refinitiv Data Library for Python
2+
3+
## Summary
4+
5+
These Python tutorials demonstrate how to programmatically access content residing within the **Refinitiv Data Platform (RDP)** using a single, ease of use Library called the **Refinitiv Data Library for Python**. The platform refers to the layer of data services providing both streaming and non-streaming content serving different clients, from the simple desktop interface to the enterprise application.
6+
7+
The **Refinitiv Data Library for Python** is a Refinitiv supported Library
8+
It is available on PyPi at https://pypi.org/project/refinitiv-data/
9+
10+
The Refinitiv Data Library for Python is structured as a stack of interfaces and libraries designed to foster the adoption of our platform by both financial coders and professional developers to programmatically access financial content.
11+
12+
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
13+
14+
### **Configuration**
15+
16+
This folder contains the configuration file - ***refinitiv-data.config.json*** - for the Refinitiv Data Library for Python. Before running any of the tutorials, you must modify this file depending on the access channel and connection parameters that you will use to connect to the Refinitiv Data Platform. This necessary configuration step is explained in the [Quick Start guide](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-python/quick-start)
17+
18+
### **Quick Start**
19+
20+
The *Quick Start* example focuses on choosing the correct session type (Platform/Desktop/Deployed) and establishing a connection to validate your credentials/connectivity parameters.
21+
22+
23+
### **Tutorials\\Content**
24+
25+
The *Content* examples target higher-level abstractions representing financial items like Pricing, News, Historical Data, etc. The *Content* layer can easily be used by both professional developers and financial coders. It provides great flexibility for commonly used financial objects.
26+
27+
### **Tutorials\\Delivery**
28+
29+
The *Delivery* examples target the interfaces defined within the lowest abstraction layer of the library. The examples provide core level services including logging and WebSocket customization. In addition, different delivery service examples such as Request/Reply data endpoints and real-time streaming data.
30+
31+
The examples should be used in conjunction with the **Tutorials** and **Documentation** available on the [Refinitiv Developer Portal](https://developers.refinitiv.com/en/api-catalog/refinitiv-data-platform/refinitiv-data-library-for-python)

0 commit comments

Comments
 (0)