Skip to content

Commit 9d83a23

Browse files
committed
Add sub-folder specific README files
1 parent a3d4100 commit 9d83a23

File tree

5 files changed

+68
-25
lines changed

5 files changed

+68
-25
lines changed

Configuration/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
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 and is available on PyPi at https://pypi.org/project/refinitiv-data/
8+
9+
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.
10+
11+
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
12+
13+
### **Configuration**
14+
15+
This Configuration 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)
16+
17+
The accompanying tutorials 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)

Quick Start/README.md

Lines changed: 4 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,18 @@
44

55
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.
66

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/
7+
The **Refinitiv Data Library for Python** is a Refinitiv supported Library and is available on PyPi at https://pypi.org/project/refinitiv-data/
98

109
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.
1110

1211
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
1312

1413
### **Configuration**
1514

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)
15+
The Configuration 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)
1716

1817
### **Quick Start**
1918

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.
19+
The *Quick Start* notebook focuses on choosing the correct session type (Platform/Desktop/Deployed) and establishing a connection to validate your credentials/connectivity parameters.
2120

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)
21+
The tutorials 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)

Tutorials/2.Content/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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 and is available on PyPi at https://pypi.org/project/refinitiv-data/
8+
9+
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.
10+
11+
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
12+
13+
### **Configuration**
14+
15+
The Configuration 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)
16+
17+
### **Tutorials\\Content**
18+
19+
The *Content* tutorials target higher-level abstractions representing financial items like Pricing, Symbology, 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.
20+
21+
The tutorials 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)

Tutorials/3.Delivery/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
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 and is available on PyPi at https://pypi.org/project/refinitiv-data/
8+
9+
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.
10+
11+
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
12+
13+
### **Configuration**
14+
15+
The Configuration 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)
16+
17+
### **Tutorials\\Delivery**
18+
19+
The *Delivery* tutorials target the interfaces defined within the lowest abstraction layer of the library. The tutorials demonstrate access to content including Level 1 & 2 Streaming Data and Request/Reply data endpoints such as Instrument Pricing Analytics, News etc.
20+
21+
The tutorials 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)

Tutorials/README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,22 @@
44

55
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.
66

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/
7+
The **Refinitiv Data Library for Python** is a Refinitiv supported Library and is available on PyPi at https://pypi.org/project/refinitiv-data/
98

109
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.
1110

1211
Based on this stack of interfaces, the examples defined within this section have been organized into the following folders:
1312

1413
### **Configuration**
1514

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-
15+
The Configuration 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)
2216

2317
### **Tutorials\\Content**
2418

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.
19+
The *Content* tutorials target higher-level abstractions representing financial items like Pricing, Symbology, 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.
2620

2721
### **Tutorials\\Delivery**
2822

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.
23+
The *Delivery* tutorials target the interfaces defined within the lowest abstraction layer of the library. The tutorials demonstrate access to content including Level 2 Streaming Data, and Request/Reply data endpoints such as Instrument Pricing Analytics, News etc.
3024

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)
25+
The tutorials 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)