This is an automated email from the ASF dual-hosted git repository.
paleolimbot pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/sedona-db.git
The following commit(s) were added to refs/heads/main by this push:
new 9a66741a chore(python/sedonadb): Add README to PyPI index page (#327)
9a66741a is described below
commit 9a66741a75400cdfd3cddf52ec1988dacf6a0a56
Author: Dewey Dunnington <[email protected]>
AuthorDate: Mon Nov 24 10:11:05 2025 -0600
chore(python/sedonadb): Add README to PyPI index page (#327)
---
python/sedonadb/README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
python/sedonadb/pyproject.toml | 1 +
2 files changed, 43 insertions(+)
diff --git a/python/sedonadb/README.md b/python/sedonadb/README.md
new file mode 100644
index 00000000..dfbad50b
--- /dev/null
+++ b/python/sedonadb/README.md
@@ -0,0 +1,42 @@
+<!---
+ 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.
+-->
+
+# SedonaDB Python
+
+This package is a Python interface to
[SedonaDB](https://sedona.apache.org/sedonadb).
+
+## Installation
+
+SedonaDB for Python can be installed from [PyPI](https://pypi.org):
+
+```shell
+pip install "apache-sedona[db]"
+```
+
+## Example
+
+```python
+import sedona.db
+
+sd = sedona.db.connect()
+sd.options.interactive = True
+
+url =
"https://raw.githubusercontent.com/geoarrow/geoarrow-data/v0.2.0/natural-earth/files/natural-earth_cities_geo.parquet";
+sd.read_parquet(url).head(5)
+```
diff --git a/python/sedonadb/pyproject.toml b/python/sedonadb/pyproject.toml
index ff949dfd..8e10481c 100644
--- a/python/sedonadb/pyproject.toml
+++ b/python/sedonadb/pyproject.toml
@@ -21,6 +21,7 @@ build-backend = "maturin"
[project]
name = "sedonadb"
+readme = "README.md"
requires-python = ">=3.9"
classifiers = [
"Programming Language :: Rust",
