You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 4d173ce
Browse filesBrowse the repository at this point in the historyBrowse files
Welcome to the documentation for the Python SDK for the Data Availability Layer by Syntropy! This SDK allows seamless integration with our Data Availability Layer solution, enabling you to leverage real-time data streams in your Python applications. With the Python SDK, you can unlock the power of the Data Availability Layer and harness real-time insights for your data-driven projects.
3
+
Welcome to the documentation for the Python SDK for the Data Layer by Syntropy! This SDK allows seamless integration with our Data Layer solution, enabling you to leverage real-time data streams in your Python applications. With the Python SDK, you can unlock the power of the Data Layer and harness real-time insights for your data-driven projects.
4
4
5
-
[pubsub-python](https://github.com/SyntropyNet/pubsub-python)is a Python example illustrating the use of the Syntropy Data Availability Layer project, which facilitates subscription to existing data streams or publishing new ones. This example employs the NATS messaging system and offers a simpler starting point for integrating Python applications with the Syntropy Data Availability Layer platform.
5
+
[pubsub-python](https://github.com/SyntropyNet/pubsub-python)is a Python example illustrating the use of the Syntropy Data Layer project, which facilitates subscription to existing data streams or publishing new ones. This example employs the NATS messaging system and offers a simpler starting point for integrating Python applications with the Syntropy Data Layer platform.
6
6
7
7
# Installation
8
8
9
-
To install the Python SDK for Data Availability Layer, you can use pip, the Python package manager. Here's an example of how to install it:
9
+
To install the Python SDK for Data Layer, you can use pip, the Python package manager. Here's an example of how to install it:
10
10
11
11
```shell
12
12
pip install syntropynet-pubsub
13
13
```
14
14
15
15
# Getting Started
16
16
17
-
Before you begin using the Python SDK, make sure you have the necessary credentials and access tokens from the Syntropy Developer Portalplatform. These credentials will allow you to connect to the Data Availability Layer and subscribe to or publish data streams.
18
-
19
-
## Usage
20
-
21
-
1. Import the SDK:
22
-
23
-
```python
24
-
from syntropynet_pubsub import Data Availability LayerClient
25
-
```
26
-
27
-
2. Initialize the client:
28
-
29
-
```python
30
-
client = Data Availability LayerClient(access_token="your-access-token", private_key="your-private-key")
31
-
```
32
-
33
-
3. Subscribe to a Data Stream:
34
-
35
-
```python
36
-
stream = client.subscribe("stream-name")
37
-
```
38
-
39
-
4. Receive Data Stream Events:
40
-
41
-
```python
42
-
for event in stream.events():
43
-
# Handle the data stream event
44
-
print("Received event:", event)
45
-
```
46
-
47
-
5. Publish Data to a Stream:
48
-
49
-
```python
50
-
client.publish("stream-name", b"Hello, Data Availability Layer!")
51
-
```
17
+
Before you begin using the Python SDK, make sure you have the necessary credentials and access tokens from the Syntropy [Developer Portal](https://developer-portal.syntropynet.com/) platform. These credentials will allow you to connect to the Data Layer and subscribe to or publish data streams.
52
18
53
19
## Examples
54
20
55
21
For detailed usage examples, please refer to the [examples directory](https://github.com/SyntropyNet/pubsub-python/examples) in the repository. These examples cover various scenarios and demonstrate how to utilize the SDK's features effectively.
56
22
57
-
The preferred authentication method is using an access token from the developer portal.
23
+
The preferred authentication method is using an access token from the [developer portal](https://developer-portal.syntropynet.com/).
@@ -117,24 +83,9 @@ To streamline the pull request process, we have provided a [Pull Request Templat
117
83
118
84
We appreciate your contributions and thank you for your support in making this project better!
119
85
120
-
## Contribution Guidelines
121
-
122
-
To contribute to this project, please follow the guidelines outlined in the [Contribution.md](CONTRIBUTING.md) file. It covers important information about how to submit bug reports, suggest new features, and submit pull requests.
123
-
124
-
## Code of Conduct
125
-
This project adheres to a [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a welcoming and inclusive environment for all contributors. Please review the guidelines and make sure to follow them in all interactions within the project.
126
-
127
-
## Commit Message Format
128
-
When making changes to the codebase, it's important to follow a consistent commit message format. Please refer to the [Commit Message Format](commit-template.md) for details on how to structure your commit messages.
129
-
130
-
## Pull Request Template
131
-
To streamline the pull request process, we have provided a [Pull Request Template](pull-request-template.md) that includes the necessary sections for describing your changes, related issues, proposed changes, and any additional information. Make sure to fill out the template when submitting a pull request.
132
-
133
-
We appreciate your contributions and thank you for your support in making this project better!
134
-
135
86
136
87
# Support
137
88
138
-
If you encounter any difficulties or have questions regarding the Python SDK for Data Availability Layer, please reach out to our support team at support@syntropynet.com. We are here to assist you and ensure a smooth experience with our SDK.
89
+
If you encounter any difficulties or have questions regarding the Python SDK for Data Layer, please reach out to our support team at [Discord #developer-discussion](https://discord.com/channels/503896258881126401/1125658694399561738). We are here to assist you and ensure a smooth experience with our SDK.
139
90
140
-
We hope this documentation provides you with a comprehensive understanding of the Python SDK for the Data Availability Layer. Enjoy leveraging real-time data streams and unlocking the power of the Data Availability Layer in your Python applications!
91
+
We hope this documentation provides you with a comprehensive understanding of the Python SDK for the Data Layer. Enjoy leveraging real-time data streams and unlocking the power of the Data Layer in your Python applications!
0 commit comments