This is an automated email from the ASF dual-hosted git repository.
agrove pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-python.git
The following commit(s) were added to refs/heads/main by this push:
new 856b310 Website fixes (#702)
856b310 is described below
commit 856b31014299f34f1e2191f61273bb40a791c47d
Author: Michael J Ward <[email protected]>
AuthorDate: Wed May 15 11:36:42 2024 -0500
Website fixes (#702)
* docs: link to examples using full URL in README
PyPI otherwise renders these relative to the `datafusion-python` page,
so when users currently get a 404 when they click on one of these links.
Fixes #699
* docs: update project.urls in pyproject.toml
* docs: update README with apache TLP URLs
* docs u pdate docs/README.md with apache TLP URLs
* docs: update index.rst with TLP URLs
* docs: update to new branded logos
---
README.md | 34 ++++++++++-----------
docs/README.md | 12 ++++----
docs/source/_static/images/2x_bgwhite_original.png | Bin 0 -> 60451 bytes
.../images/DataFusion-Logo-Background-White.png | Bin 12401 -> 0 bytes
.../images/DataFusion-Logo-Background-White.svg | 1 -
.../source/_static/images/DataFusion-Logo-Dark.png | Bin 20134 -> 0 bytes
.../source/_static/images/DataFusion-Logo-Dark.svg | 1 -
.../_static/images/DataFusion-Logo-Light.png | Bin 19102 -> 0 bytes
.../_static/images/DataFusion-Logo-Light.svg | 1 -
docs/source/_static/images/original.png | Bin 0 -> 26337 bytes
docs/source/_static/images/original.svg | 31 +++++++++++++++++++
docs/source/_static/images/original2x.png | Bin 0 -> 66517 bytes
docs/source/_templates/docs-sidebar.html | 2 +-
docs/source/conf.py | 2 +-
docs/source/index.rst | 8 ++---
pyproject.toml | 6 ++--
16 files changed, 63 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md
index 4345b52..b1d5397 100644
--- a/README.md
+++ b/README.md
@@ -19,16 +19,16 @@
# DataFusion in Python
-[](https://github.com/apache/arrow-datafusion-python/actions/workflows/test.yaml)
-[](https://github.com/apache/arrow-datafusion-python/actions/workflows/build.yml)
+[](https://github.com/apache/datafusion-python/actions/workflows/test.yaml)
+[](https://github.com/apache/datafusion-python/actions/workflows/build.yml)
-This is a Python library that binds to [Apache
Arrow](https://arrow.apache.org/) in-memory query engine
[DataFusion](https://github.com/apache/arrow-datafusion).
+This is a Python library that binds to [Apache
Arrow](https://arrow.apache.org/) in-memory query engine
[DataFusion](https://github.com/apache/datafusion).
DataFusion's Python bindings can be used as a foundation for building new data
systems in Python. Here are some examples:
- [Dask SQL](https://github.com/dask-contrib/dask-sql) uses DataFusion's
Python bindings for SQL parsing, query
planning, and logical plan optimizations, and then transpiles the logical
plan to Dask operations for execution.
-- [DataFusion Ballista](https://github.com/apache/arrow-ballista) is a
distributed SQL query engine that extends
+- [DataFusion Ballista](https://github.com/apache/datafusion-ballista) is a
distributed SQL query engine that extends
DataFusion's Python bindings for distributed use cases.
It is also possible to use these Python bindings directly for DataFrame and
SQL operations, but you may find that
@@ -120,23 +120,23 @@ See [examples](examples/README.md) for more information.
### Executing Queries with DataFusion
-- [Query a Parquet file using SQL](./examples/sql-parquet.py)
-- [Query a Parquet file using the DataFrame
API](./examples/dataframe-parquet.py)
-- [Run a SQL query and store the results in a Pandas
DataFrame](./examples/sql-to-pandas.py)
-- [Run a SQL query with a Python user-defined function
(UDF)](./examples/sql-using-python-udf.py)
-- [Run a SQL query with a Python user-defined aggregation function
(UDAF)](./examples/sql-using-python-udaf.py)
-- [Query PyArrow Data](./examples/query-pyarrow-data.py)
-- [Create dataframe](./examples/import.py)
-- [Export dataframe](./examples/export.py)
+- [Query a Parquet file using
SQL](https://github.com/apache/datafusion-python/blob/main/examples/sql-parquet.py)
+- [Query a Parquet file using the DataFrame
API](https://github.com/apache/datafusion-python/blob/main/examples/dataframe-parquet.py)
+- [Run a SQL query and store the results in a Pandas
DataFrame](https://github.com/apache/datafusion-python/blob/main/examples/sql-to-pandas.py)
+- [Run a SQL query with a Python user-defined function
(UDF)](https://github.com/apache/datafusion-python/blob/main/examples/sql-using-python-udf.py)
+- [Run a SQL query with a Python user-defined aggregation function
(UDAF)](https://github.com/apache/datafusion-python/blob/main/examples/sql-using-python-udaf.py)
+- [Query PyArrow
Data](https://github.com/apache/datafusion-python/blob/main/examples/query-pyarrow-data.py)
+- [Create
dataframe](https://github.com/apache/datafusion-python/blob/main/examples/import.py)
+- [Export
dataframe](https://github.com/apache/datafusion-python/blob/main/examples/export.py)
### Running User-Defined Python Code
-- [Register a Python UDF with DataFusion](./examples/python-udf.py)
-- [Register a Python UDAF with DataFusion](./examples/python-udaf.py)
+- [Register a Python UDF with
DataFusion](https://github.com/apache/datafusion-python/blob/main/examples/python-udf.py)
+- [Register a Python UDAF with
DataFusion](https://github.com/apache/datafusion-python/blob/main/examples/python-udaf.py)
### Substrait Support
-- [Serialize query plans using Substrait](./examples/substrait.py)
+- [Serialize query plans using
Substrait](https://github.com/apache/datafusion-python/blob/main/examples/substrait.py)
## How to install (from pip)
@@ -172,7 +172,7 @@ Bootstrap (Conda):
```bash
# fetch this repo
-git clone [email protected]:apache/arrow-datafusion-python.git
+git clone [email protected]:apache/datafusion-python.git
# create the conda environment for dev
conda env create -f ./conda/environments/datafusion-dev.yaml -n datafusion-dev
# activate the conda environment
@@ -183,7 +183,7 @@ Bootstrap (Pip):
```bash
# fetch this repo
-git clone [email protected]:apache/arrow-datafusion-python.git
+git clone [email protected]:apache/datafusion-python.git
# prepare development environment (used to build wheel / install in
development)
python3 -m venv venv
# activate the venv
diff --git a/docs/README.md b/docs/README.md
index 8cb101d..b4b9412 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -20,7 +20,7 @@
# DataFusion Documentation
This folder contains the source content of the [Python API](./source/api).
-This is published to https://arrow.apache.org/datafusion-python/ by a GitHub
action
+This is published to https://datafusion.apache.org/python by a GitHub action
when changes are merged to the main branch.
## Dependencies
@@ -66,15 +66,15 @@ firefox build/html/index.html
## Release Process
-This documentation is hosted at https://arrow.apache.org/datafusion-python/
+This documentation is hosted at https://datafusion.apache.org/python
When the PR is merged to the `main` branch of the DataFusion
-repository, a [github
workflow](https://github.com/apache/arrow-datafusion-python/blob/main/.github/workflows/docs.yaml)
which:
+repository, a [github
workflow](https://github.com/apache/datafusion-python/blob/main/.github/workflows/docs.yaml)
which:
1. Builds the html content
-2. Pushes the html content to the
[`asf-site`](https://github.com/apache/arrow-datafusion-python/tree/asf-site)
branch in this repository.
+2. Pushes the html content to the
[`asf-site`](https://github.com/apache/datafusion-python/tree/asf-site) branch
in this repository.
The Apache Software Foundation provides https://arrow.apache.org/,
which serves content based on the configuration in
-[.asf.yaml](https://github.com/apache/arrow-datafusion-python/blob/main/.asf.yaml),
-which specifies the target as https://arrow.apache.org/datafusion-python/.
\ No newline at end of file
+[.asf.yaml](https://github.com/apache/datafusion-python/blob/main/.asf.yaml),
+which specifies the target as https://datafusion.apache.org/python.
\ No newline at end of file
diff --git a/docs/source/_static/images/2x_bgwhite_original.png
b/docs/source/_static/images/2x_bgwhite_original.png
new file mode 100644
index 0000000..abb5fca
Binary files /dev/null and b/docs/source/_static/images/2x_bgwhite_original.png
differ
diff --git a/docs/source/_static/images/DataFusion-Logo-Background-White.png
b/docs/source/_static/images/DataFusion-Logo-Background-White.png
deleted file mode 100644
index 023c237..0000000
Binary files a/docs/source/_static/images/DataFusion-Logo-Background-White.png
and /dev/null differ
diff --git a/docs/source/_static/images/DataFusion-Logo-Background-White.svg
b/docs/source/_static/images/DataFusion-Logo-Background-White.svg
deleted file mode 100644
index b3bb47c..0000000
--- a/docs/source/_static/images/DataFusion-Logo-Background-White.svg
+++ /dev/null
@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 350 170"><rect
width="100%" height="105%"
fill="white"/><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-miterlimit:10;stroke-width:0.75px;stroke-dasharray:0.75
3;}.cls-2{fill:#f3971f;}.cls-3{fill:#f29720;}</style></defs><title>DataFUSION-Logo-Dark</title><g
id="Layer_2" data-name="Layer 2" transform="translate(10 10)"><g
id="logo"><path class="cls-1"
d="M257.26,112.82c16,20.72,25.14,36.57,22,39.34"/><path class="c [...]
\ No newline at end of file
diff --git a/docs/source/_static/images/DataFusion-Logo-Dark.png
b/docs/source/_static/images/DataFusion-Logo-Dark.png
deleted file mode 100644
index cc60f12..0000000
Binary files a/docs/source/_static/images/DataFusion-Logo-Dark.png and
/dev/null differ
diff --git a/docs/source/_static/images/DataFusion-Logo-Dark.svg
b/docs/source/_static/images/DataFusion-Logo-Dark.svg
deleted file mode 100644
index e16f244..0000000
--- a/docs/source/_static/images/DataFusion-Logo-Dark.svg
+++ /dev/null
@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 329.21
164.93"><defs><style>.cls-1{fill:none;stroke:#000;stroke-linecap:round;stroke-miterlimit:10;stroke-width:0.75px;stroke-dasharray:0.75
3;}.cls-2{fill:#f3971f;}.cls-3{fill:#f29720;}</style></defs><title>DataFUSION-Logo-Dark</title><g
id="Layer_2" data-name="Layer 2"><g id="logo"><path class="cls-1"
d="M257.26,112.82c16,20.72,25.14,36.57,22,39.34"/><path class="cls-1"
d="M184.24,37.13c6.55,4.41,15.83,12.47,26.43,23"/><path class="c [...]
\ No newline at end of file
diff --git a/docs/source/_static/images/DataFusion-Logo-Light.png
b/docs/source/_static/images/DataFusion-Logo-Light.png
deleted file mode 100644
index 8992213..0000000
Binary files a/docs/source/_static/images/DataFusion-Logo-Light.png and
/dev/null differ
diff --git a/docs/source/_static/images/DataFusion-Logo-Light.svg
b/docs/source/_static/images/DataFusion-Logo-Light.svg
deleted file mode 100644
index b3bef21..0000000
--- a/docs/source/_static/images/DataFusion-Logo-Light.svg
+++ /dev/null
@@ -1 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg"; viewBox="0 0 329.21
164.93"><defs><style>.cls-1{fill:none;stroke:#fff;stroke-linecap:round;stroke-miterlimit:10;stroke-width:0.75px;stroke-dasharray:0.75
3;}.cls-2{fill:#fff;}.cls-3{fill:#f3971f;}.cls-4{fill:#f29720;}</style></defs><title>DataFUSION-Logo-Light</title><g
id="Layer_2" data-name="Layer 2"><g id="logo"><path class="cls-1"
d="M257.26,112.82c16,20.72,25.14,36.57,22,39.34"/><path class="cls-1"
d="M184.24,37.13c6.55,4.41,15.83,12.47,26.43, [...]
\ No newline at end of file
diff --git a/docs/source/_static/images/original.png
b/docs/source/_static/images/original.png
new file mode 100644
index 0000000..687f946
Binary files /dev/null and b/docs/source/_static/images/original.png differ
diff --git a/docs/source/_static/images/original.svg
b/docs/source/_static/images/original.svg
new file mode 100644
index 0000000..6ba0ece
--- /dev/null
+++ b/docs/source/_static/images/original.svg
@@ -0,0 +1,31 @@
+<svg width="801" height="168" viewBox="0 0 801 168" fill="none"
xmlns="http://www.w3.org/2000/svg";>
+<g clip-path="url(#clip0_1_181)">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M76.1297 168C88.4597 168
99.6097 158.25 107.58 142.55C127.23 144.6 143.09 139.99 149.76 128.51C156.29
117.25 152.65 101.68 141.58 86.09C152.36 70.67 155.85 55.32 149.39 44.19C143.01
33.19 128.19 28.5 109.69 29.92C101.65 11.62 89.5997 0 76.1297 0C62.6597 0
50.4997 11.73 42.4497 30.18C24.3497 28.97 9.87966 33.68 3.59966 44.51C-2.81034
55.56 0.589656 70.78 11.1897 86.09C0.299656 101.57 -3.24034 117.01 3.23966
128.18C9.80966 139.5 25.3097 144. [...]
+<path d="M204.34 45.97H192.83L190.47 52.2H185.2L196.07 23.88H201.47L212.54
52.2H206.78L204.34 45.97ZM202.74 41.74L198.54 30.99L194.46
41.74H202.73H202.74Z" fill="#1F2937"/>
+<path d="M235.55 23.88H246.82C249.59 23.88 251.9 24.73 253.73 26.44C255.57
28.14 256.49 30.38 256.49 33.15C256.49 35.92 255.57 38.2 253.73 39.9C251.89
41.6 249.59 42.46 246.82 42.46H240.95V52.21H235.56V23.89L235.55 23.88ZM240.94
37.26H246.85C248 37.26 248.96 36.87 249.73 36.1C250.5 35.3 250.89 34.32 250.89
33.14C250.89 31.96 250.5 31 249.73 30.22C248.98 29.45 248.02 29.06 246.85
29.06H240.94V37.25V37.26Z" fill="#1F2937"/>
+<path d="M293.67 45.97H282.16L279.8 52.2H274.53L285.4 23.88H290.79L301.86
52.2H296.1L293.66 45.97H293.67ZM292.07 41.74L287.87 30.99L283.79
41.74H292.06H292.07Z" fill="#1F2937"/>
+<path d="M335.99 23C338.57 23 340.92 23.68 343.02 25.04C345.15 26.37 346.84
28.18 348.1 30.47L343.1 32.87C341.37 29.57 339 27.92 335.99 27.92C333.62 27.92
331.65 28.91 330.07 30.88C328.53 32.82 327.75 35.22 327.75 38.07C327.75 40.92
328.52 43.32 330.07 45.26C331.62 47.18 333.59 48.14 335.99 48.14C337.45 48.14
338.81 47.73 340.07 46.9C341.32 46.05 342.32 44.93 343.07 43.54L347.99
45.9C346.79 48.14 345.13 49.89 342.99 51.17C340.86 52.42 338.53 53.05 336
53.05C331.95 53.05 328.63 51.65 326. [...]
+<path d="M393.49
52.2H388.09V40.61H377.1V52.2H371.71V23.88H377.1V35.43H388.09V23.88H393.49V52.2Z"
fill="#1F2937"/>
+<path d="M435.17
29.07H423.9V35.46H432.41V40.65H423.9V47H435.17V52.19H418.51V23.87H435.17V29.06V29.07Z"
fill="#1F2937"/>
+<path d="M185 76.1H207.25C218.63 76.1 227.58 79.3 234.1 85.69C240.69 92.02
243.98 100.14 243.98 110.04C243.98 119.94 240.69 128.1 234.1 134.49C227.51
140.88 218.53 144.08 207.15 144.08H184.99V76.1H185ZM199.96
90.49V129.7H206.67C209.55 129.7 212.2 129.38 214.63 128.74C217.12 128.1 219.43
127.08 221.54 125.67C223.71 124.26 225.41 122.25 226.62 119.63C227.83 116.95
228.44 113.75 228.44 110.04C228.44 106.33 227.83 103.17 226.62 100.55C225.4
97.93 223.71 95.92 221.54 94.51C219.43 93.1 217.16 [...]
+<path d="M291.82 130.85H264.96L259.97 144.08H245.39L271.38 76.1H286.34L312.91
144.08H296.89L291.81 130.85H291.82ZM287.4 119.35L278.29 95.76L269.37
119.35H287.4Z" fill="#1F2937"/>
+<path d="M362.7 90.49H342.94V144.09H327.98V90.49H308.51V76.11H362.7V90.49Z"
fill="#1F2937"/>
+<path d="M404.77 130.85H377.92L372.93 144.08H358.35L384.34 76.1H399.3L425.87
144.08H409.85L404.77 130.85ZM400.36 119.35L391.25 95.76L382.33 119.35H400.36Z"
fill="#1F2937"/>
+<path d="M474.73
90.49H448.45V102.95H468.4V117.33H448.45V144.08H433.49V76.1H474.73V90.48V90.49Z"
fill="#1F2937"/>
+<path d="M541.71 76.1V118.96C541.65 127.27 538.96 133.85 533.65 138.71C528.41
143.57 521.53 146 513.03 146C504.53 146 497.78 143.57 492.41 138.71C487.04
133.85 484.39 127.27 484.45 118.96V76.1H499.32V119.05C499.32 122.88 500.6
125.95 503.16 128.25C505.78 130.49 509.08 131.61 513.04 131.61C517 131.61
520.27 130.49 522.82 128.25C525.38 125.95 526.69 122.88 526.75
119.05V76.1H541.71Z" fill="#1F2937"/>
+<path d="M578.69 73.99C585.72 73.99 591.96 75.59 597.39 78.78L590.77
91.24C585.98 89.19 581.43 88.17 577.15 88.17C570.95 88.17 567.85 90.25 567.85
94.4C567.85 96.45 569.03 98.17 571.4 99.58C573.83 100.92 577.28 102.39 581.76
103.99C586.3 105.52 589.72 106.96 592.02 108.3C598.22 111.88 601.32 117.25
601.32 124.41C601.32 131.12 598.86 136.4 593.93 140.23C589.01 144.07 582.87
145.98 575.52 145.98C571.36 145.98 567.05 145.21 562.57 143.68C558.09 142.15
554.61 140.39 552.12 138.41L560.18 126. [...]
+<path d="M626.79 144.08H611.83V76.1H626.79V144.08Z" fill="#1F2937"/>
+<path d="M647.04 84.16C653.88 77.38 662.48 74 672.84 74C683.2 74 691.73 77.39
698.45 84.16C705.23 90.87 708.62 99.4 708.62 109.76C708.62 120.12 705.33 128.68
698.74 135.45C692.15 142.16 683.52 145.68 672.84 146C662.48 146 653.88 142.58
647.04 135.74C640.26 128.84 636.87 120.21 636.87 109.85C636.87 99.49 640.26
90.93 647.04 84.15V84.16ZM672.84 87.61C666.64 87.61 661.68 89.69 657.97
93.84C654.26 97.99 652.41 103.3 652.41 109.76C652.41 116.22 654.26 121.62
657.97 125.96C661.74 130.24 666.7 [...]
+<path d="M775 144.08H759.65L732.7 101.99V144.08H718.7V76.1H732.99L761
118.57V76.1H775V144.08Z" fill="#1F2937"/>
+<path d="M788.01
78.18H784.62V87.44H782.46V78.18H779.13V76.1H788.01V78.18ZM800.56
87.45H798.48V80.17L795.5 85.79H794.12L791.14 80.17L791.12
87.45H789.1V76.11H791.13L794.87 83.04L798.45 76.11H800.51L800.53 87.45H800.56Z"
fill="#1F2937"/>
+</g>
+<defs>
+<linearGradient id="paint0_linear_1_181" x1="17.0897" y1="117.74" x2="162.73"
y2="36.78" gradientUnits="userSpaceOnUse">
+<stop stop-color="#EF4137"/>
+<stop offset="1" stop-color="#FBB042"/>
+</linearGradient>
+<clipPath id="clip0_1_181">
+<rect width="800.56" height="168" fill="white"/>
+</clipPath>
+</defs>
+</svg>
diff --git a/docs/source/_static/images/original2x.png
b/docs/source/_static/images/original2x.png
new file mode 100644
index 0000000..a740210
Binary files /dev/null and b/docs/source/_static/images/original2x.png differ
diff --git a/docs/source/_templates/docs-sidebar.html
b/docs/source/_templates/docs-sidebar.html
index 6541b77..44deeed2 100644
--- a/docs/source/_templates/docs-sidebar.html
+++ b/docs/source/_templates/docs-sidebar.html
@@ -1,6 +1,6 @@
<a class="navbar-brand" href="{{ pathto(master_doc) }}">
- <img src="{{ pathto('_static/images/DataFusion-Logo-Background-White.png',
1) }}" class="logo" alt="logo">
+ <img src="{{ pathto('_static/images/2x_bgwhite_original.png', 1) }}"
class="logo" alt="logo">
</a>
<form class="bd-search d-flex align-items-center" action="{{ pathto('search')
}}" method="get">
diff --git a/docs/source/conf.py b/docs/source/conf.py
index a6beee5..c0da8b2 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -101,7 +101,7 @@ html_context = {
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
-html_logo = "_static/images/DataFusion-Logo-Background-White.png"
+html_logo = "_static/images/2x_bgwhite_original.png"
html_css_files = ["theme_overrides.css"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 6cec3a1..16c88e0 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -19,7 +19,7 @@
DataFusion in Python
====================
-This is a Python library that binds to `Apache Arrow
<https://arrow.apache.org/>`_ in-memory query engine `DataFusion
<https://github.com/apache/arrow/tree/master/rust/datafusion>`_.
+This is a Python library that binds to `Apache Arrow
<https://arrow.apache.org/>`_ in-memory query engine `DataFusion
<https://github.com/apache/datafusion>`_.
Like pyspark, it allows you to build a plan through SQL or a DataFrame API
against in-memory data, parquet or CSV files, run it in a multi-threaded
environment, and obtain the result back in Python.
@@ -72,10 +72,10 @@ Example
:maxdepth: 1
:caption: LINKS
- Github and Issue Tracker <https://github.com/apache/arrow-datafusion-python>
+ Github and Issue Tracker <https://github.com/apache/datafusion-python>
Rust's API Docs <https://docs.rs/datafusion/latest/datafusion/>
- Code of conduct
<https://github.com/apache/arrow-datafusion/blob/main/CODE_OF_CONDUCT.md>
- Examples
<https://github.com/apache/arrow-datafusion-python/tree/main/examples>
+ Code of conduct
<https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md>
+ Examples <https://github.com/apache/datafusion-python/tree/main/examples>
.. _toc.guide:
.. toctree::
diff --git a/pyproject.toml b/pyproject.toml
index 24bd296..444aa8e 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -47,9 +47,9 @@ dependencies = [
]
[project.urls]
-homepage = "https://arrow.apache.org/datafusion-python";
-documentation = "https://arrow.apache.org/datafusion-python";
-repository = "https://github.com/apache/arrow-datafusion-python";
+homepage = "https://datafusion.apache.org/python";
+documentation = "https://datafusion.apache.org/python";
+repository = "https://github.com/apache/datafusion-python";
[tool.isort]
profile = "black"
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
