Wei-Chiu Chuang created HDDS-13165:
--------------------------------------
Summary: [Docs] Python client developer guide
Key: HDDS-13165
URL: https://issues.apache.org/jira/browse/HDDS-13165
Project: Apache Ozone
Issue Type: Task
Components: documentation
Reporter: Wei-Chiu Chuang
Create a user document in Markdown format for Python developers who want to
access Apache Ozone. This document will be part of the Ozone Client Interfaces
page: https://ozone.apache.org/docs/edge/interface.html.
📌 **Audience**: Python developers familiar with Python integration and Ozone.
Skip the introduction.
📌 **Structure**:
- Setup and Prerequisites:
- Required libraries (PyArrow, Boto3, WebHDFS)
- Required configurations (e.g., HADOOP_CONF_DIR, Ozone URIs, credentials,
authentication)
- Access Method 1: PyArrow with libhdfs
- Setup steps (including any system paths or environment variables)
- Python code sample (validate for correctness)
- Access Method 2: Boto3 with Ozone S3 Gateway
- Setup steps (including Ozone S3 endpoint format, bucket naming conventions,
credentials)
- Python code sample (validate for correctness)
- Access Method 3: WebHDFS/HttpFS or REST API
- Setup steps (including endpoint URL, authentication)
- Python code sample (using requests or webhdfs)
- Access from PySpark
- Configuration settings in Spark (fs.ozone. settings)
- Python code sample for reading/writing data to Ozone
- Troubleshooting Tips
- Common issues (e.g., authentication failures, connection errors)
- Suggested debugging techniques
- References and Further Resources
- Links to official Ozone documentation, PyArrow, Boto3, WebHDFS, PySpark
📌 **Markdown Format**:
- Use proper headers (##, ###) for each section.
- Include Python syntax highlighting in code blocks (```python).
- Use clear formatting and spacing for readability.
- Include warnings or notes where appropriate (e.g., > **Note:**).
- If applicable, include a simple diagram showing connection flows.
📌 **Quality Checks**:
- Validate all code samples for correctness.
- Ensure the document is clear and concise.
- Focus only on actionable instructions and setup information.
Generate the complete Markdown document in response.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
