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 @@ + + +# 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",