mirror of
				https://github.com/open-metadata/OpenMetadata.git
				synced 2025-11-04 04:29:13 +00:00 
			
		
		
		
	
		
			
	
	
		
			187 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
		
		
			
		
	
	
			187 lines
		
	
	
		
			4.8 KiB
		
	
	
	
		
			Markdown
		
	
	
	
	
	
| 
								 | 
							
								---
							 | 
						||
| 
								 | 
							
								title: Python SDK
							 | 
						||
| 
								 | 
							
								slug: /python-sdk
							 | 
						||
| 
								 | 
							
								---
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiPageContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiDescription %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								## Title 1
							 | 
						||
| 
								 | 
							
								Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
							 | 
						||
| 
								 | 
							
								magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
							 | 
						||
| 
								 | 
							
								magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
							 | 
						||
| 
								 | 
							
								magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
							 | 
						||
| 
								 | 
							
								magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
							 | 
						||
| 
								 | 
							
								magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								obcaecati consectetur in exercitationem totam laborum ad voluptate!
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiDescription %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								### Title in visual info
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeWithLanguageSelector title="The Title" id="container-1" languagesArray=["json","python","java","bash"] %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```json
							 | 
						||
| 
								 | 
							
								{
							 | 
						||
| 
								 | 
							
								  "a": {
							 | 
						||
| 
								 | 
							
								    "c": "open",
							 | 
						||
| 
								 | 
							
								    "num": 5,
							 | 
						||
| 
								 | 
							
								    "val": false
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```python
							 | 
						||
| 
								 | 
							
								def my_function():
							 | 
						||
| 
								 | 
							
								  print("Hello world!")
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```java
							 | 
						||
| 
								 | 
							
								public class Main {
							 | 
						||
| 
								 | 
							
								  static void myMethod() {
							 | 
						||
| 
								 | 
							
								    System.out.print("Hello world!")
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```bash
							 | 
						||
| 
								 | 
							
								curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeWithLanguageSelector %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeBlock fileName="open.json" %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								This is a new code
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeBlock %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiDescription %}
							 | 
						||
| 
								 | 
							
								### SubTitle
							 | 
						||
| 
								 | 
							
								API description 2
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiDescription %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeWithLanguageSelector title="The Title" id="container-2" languagesArray=["json","python","java","bash"] theme="light" %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```json
							 | 
						||
| 
								 | 
							
								{
							 | 
						||
| 
								 | 
							
								  "a": {
							 | 
						||
| 
								 | 
							
								    "c": "open",
							 | 
						||
| 
								 | 
							
								    "num": 5,
							 | 
						||
| 
								 | 
							
								    "val": false
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```python
							 | 
						||
| 
								 | 
							
								def my_function():
							 | 
						||
| 
								 | 
							
								  print("Hello world!")
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```java
							 | 
						||
| 
								 | 
							
								public class Main {
							 | 
						||
| 
								 | 
							
								  static void myMethod() {
							 | 
						||
| 
								 | 
							
								    System.out.print("Hello world!")
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```bash
							 | 
						||
| 
								 | 
							
								curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeWithLanguageSelector %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeBlock fileName="open.json" theme="light" %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								This is a new code
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeBlock %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiDescription %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								## Title 2
							 | 
						||
| 
								 | 
							
								API description 2
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiDescription %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeWithLanguageSelector title="The Title" id="container-3" languagesArray=["json","python","java","bash"] theme="gray" %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```json
							 | 
						||
| 
								 | 
							
								{
							 | 
						||
| 
								 | 
							
								  "a": {
							 | 
						||
| 
								 | 
							
								    "c": "open",
							 | 
						||
| 
								 | 
							
								    "num": 5,
							 | 
						||
| 
								 | 
							
								    "val": false
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```python
							 | 
						||
| 
								 | 
							
								def my_function():
							 | 
						||
| 
								 | 
							
								  print("Hello world!")
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```java
							 | 
						||
| 
								 | 
							
								public class Main {
							 | 
						||
| 
								 | 
							
								  static void myMethod() {
							 | 
						||
| 
								 | 
							
								    System.out.print("Hello world!")
							 | 
						||
| 
								 | 
							
								  }
							 | 
						||
| 
								 | 
							
								}
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```bash
							 | 
						||
| 
								 | 
							
								curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
							 | 
						||
| 
								 | 
							
								 ``` 
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeWithLanguageSelector %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% codeBlock fileName="open.json" theme="gray" %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								This is a new code
							 | 
						||
| 
								 | 
							
								```
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /codeBlock %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiVisualInfo %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiInfoContainer %}
							 | 
						||
| 
								 | 
							
								
							 | 
						||
| 
								 | 
							
								{% /apiPageContainer %}
							 |