[GitHub] [iceberg] jackye1995 commented on a change in pull request #3184: [Python] setup new python library module structure.

[GitBox <gi...@apache.org>]

jackye1995 commented on a change in pull request #3184:
URL: https://github.com/apache/iceberg/pull/3184#discussion_r718993238



##########
File path: python/README.md
##########
@@ -0,0 +1,51 @@
+<!--
+ - Licensed to the Apache Software Foundation (ASF) under one or more
+ - contributor license agreements.  See the NOTICE file distributed with
+ - this work for additional information regarding copyright ownership.
+ - The ASF licenses this file to You under the Apache License, Version 2.0
+ - (the "License"); you may not use this file except in compliance with
+ - the License.  You may obtain a copy of the License at
+ -
+ -   http://www.apache.org/licenses/LICENSE-2.0
+ -
+ - Unless required by applicable law or agreed to in writing, software
+ - distributed under the License is distributed on an "AS IS" BASIS,
+ - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ - See the License for the specific language governing permissions and
+ - limitations under the License.
+ -->
+
+# Iceberg Python
+
+py-iceberg is a python library for programmatic access to iceberg table metadata as well as to table data in iceberg format. 
+It is an implementation of [iceberg table spec](https://iceberg.apache.org/spec/) in Python.
+
+## Getting Started
+
+py-iceberg is currently in development, for development and testing purposes the best way to install the library is to perform the following steps:
+
+```
+git clone https://github.com/apache/iceberg.git
+cd iceberg/python
+pip install -e .
+```
+
+## Testing
+
+Testing is done using tox. The config can be found in `tox.ini` within the python directory of the iceberg project.
+
+```
+# simply run tox within the python dir
+tox
+```
+
+## Get in Touch

Review comment:
       +1, I think we currently lacking this info in the community page, @jun-he could you just add this section there?




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@iceberg.apache.org
For additional commands, e-mail: issues-help@iceberg.apache.org