This is an automated email from the ASF dual-hosted git repository.
jshao pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/gravitino.git
The following commit(s) were added to refs/heads/main by this push:
new ca8553b48 [#4457] improvement(client-python): According Apache #pypi
specification (#4458)
ca8553b48 is described below
commit ca8553b48e9307cea50be8120a8986771b30d7ae
Author: Xun <[email protected]>
AuthorDate: Fri Aug 9 15:07:24 2024 +0800
[#4457] improvement(client-python): According Apache #pypi specification
(#4458)
### What changes were proposed in this pull request?
1. Rename library to apache-gravitino
2. Added Apache licenses
3. Added ASF Incubator disclaimer
4. Added project links
### Why are the changes needed?
Fix: #4457
### Does this PR introduce _any_ user-facing change?
```
pip install apache-gravitino
```
### How was this patch tested?
I published a review version in the
https://pypi.org/project/apache-gravitino/
When this PR is merged, I will delete it.
---
clients/client-python/setup.py | 18 ++++++++++++++----
docs/how-to-use-gvfs.md | 2 +-
docs/how-to-use-python-client.md | 20 ++++++++++++++++----
3 files changed, 31 insertions(+), 9 deletions(-)
diff --git a/clients/client-python/setup.py b/clients/client-python/setup.py
index bf5447dd1..1b404162f 100644
--- a/clients/client-python/setup.py
+++ b/clients/client-python/setup.py
@@ -32,15 +32,25 @@ setup(
version="0.7.0.dev0",
long_description=long_description,
long_description_content_type="text/markdown",
- url="https://github.com/apache/gravitino";,
- author="apache-gravitino",
+ author="Apache Software Foundation",
author_email="[email protected]",
+ maintainer="Apache Gravitino Community",
+ maintainer_email="[email protected]",
+ license="Apache-2.0",
+ url="https://github.com/apache/gravitino";,
python_requires=">=3.8",
+ keywords="Data, AI, metadata, catalog",
packages=find_packages(exclude=["tests*", "scripts*"]),
+ project_urls={
+ "Homepage": "https://gravitino.apache.org/";,
+ "Source Code": "https://github.com/apache/gravitino";,
+ "Documentation": "https://gravitino.apache.org/docs/overview";,
+ "Bug Tracker": "https://github.com/apache/gravitino/issues";,
+ "Slack Chat": "https://the-asf.slack.com/archives/C078RESTT19";,
+ },
classifiers=[
- "Development Status :: 3 - Alpha",
- "Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
+ "Operating System :: OS Independent",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
diff --git a/docs/how-to-use-gvfs.md b/docs/how-to-use-gvfs.md
index 96c7d4495..579bd981e 100644
--- a/docs/how-to-use-gvfs.md
+++ b/docs/how-to-use-gvfs.md
@@ -362,7 +362,7 @@ fs =
gvfs.GravitinoVirtualFileSystem(server_uri="http://localhost:8090";, metalak
You can get it by [pip](https://pip.pypa.io/en/stable/installation/):
```shell
- pip install gravitino
+ pip install apache-gravitino
```
2. Configuring the Hadoop environment.
diff --git a/docs/how-to-use-python-client.md b/docs/how-to-use-python-client.md
index 76698ff4d..5b3f4aa0c 100644
--- a/docs/how-to-use-python-client.md
+++ b/docs/how-to-use-python-client.md
@@ -5,7 +5,7 @@ date: 2024-05-09
keyword: Gravitino Python client
license: This software is licensed under the Apache License version 2.
---
-## Introduction
+# Apache Gravitino Python client
Apache Gravitino is a high-performance, geo-distributed, and federated
metadata lake.
It manages the metadata directly in different sources, types, and regions,
also provides users
@@ -26,7 +26,7 @@ install it in your local.
### Apache Gravitino Python client API
```shell
-pip install gravitino
+pip install apache-gravitino
```
1. [Manage metalake using Gravitino Python
API](./manage-metalake-using-gravitino.md?language=python)
@@ -36,7 +36,7 @@ pip install gravitino
We offer a playground environment to help you quickly understand how to use
Gravitino Python
client to manage non-tabular data on HDFS via Fileset in Gravitino. You can
refer to the
-document [How to use the playground#Launch AI components of
playground](./how-to-use-the-playground.md#launch-ai-components-of-playground)
+document [How to use the playground](./how-to-use-the-playground.md)
to launch a Gravitino server, HDFS and Jupyter notebook environment in you
local Docker environment.
Waiting for the playground Docker environment to start, you can directly open
@@ -111,7 +111,7 @@ You can ues any IDE to develop Gravitino Python Client.
Directly open the client
./gradlew :clients:client-python:distribution
```
-6. Deploy the Gravitino Python client to https://pypi.org/project/gravitino/
+6. Deploy the Gravitino Python client to
https://pypi.org/project/apache-gravitino/
```shell
./gradlew :clients:client-python:deploy
@@ -125,3 +125,15 @@ You can ues any IDE to develop Gravitino Python Client.
Directly open the client
+ User documentation: https://datastrato.ai/docs/
+ Videos on Youtube: https://www.youtube.com/@Datastrato
+ Slack Community:
[https://the-asf.slack.com#gravitino](https://the-asf.slack.com/archives/C078RESTT19)
+
+## License
+
+Gravitino is under the Apache License Version 2.0, See the
[LICENSE](https://github.com/apache/gravitino/blob/main/LICENSE) for the
details.
+
+## ASF Incubator disclaimer
+
+Apache Gravitino is an effort undergoing incubation at The Apache Software
Foundation (ASF), sponsored by the Apache Incubator.
+Incubation is required of all newly accepted projects until a further review
indicates that the infrastructure, communications,
+and decision making process have stabilized in a manner consistent with other
successful ASF projects.
+While incubation status is not necessarily a reflection of the completeness or
stability of the code,
+it does indicate that the project has yet to be fully endorsed by the ASF.
