8000 Website fixes (#702) · kylebarron/datafusion-python@856b310 · GitHub
[go: up one dir, main page]
Skip to content

Commit 856b310

Browse files
Michael-J-WardMichael-J-Ward
authored
Website fixes (apache#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 apache#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
1 parent d6c42b4 commit 856b310

16 files changed

+63
-35
lines changed

‎README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,16 @@
1919

2020
# DataFusion in Python
2121

22-
[![Python test](https://github.com/apache/arrow-datafusion-python/actions/workflows/test.yaml/badge.svg)](https://github.com/apache/arrow-datafusion-python/actions/workflows/test.yaml)
23-
[![Python Release Build](https://github.com/apache/arrow-datafusion-python/actions/workflows/build.yml/badge.svg)](https://github.com/apache/arrow-datafusion-python/actions/workflows/build.yml)
22+
[![Python test](https://github.com/apache/datafusion-python/actions/workflows/test.yaml/badge.svg)](https://github.com/apache/datafusion-python/actions/workflows/test.yaml)
23+
[![Python Release Build](https://github.com/apache/datafusion-python/actions/workflows/build.yml/badge.svg)](https://github.com/apache/datafusion-python/actions/workflows/build.yml)
2424

25-
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).
25+
This is a Python library that binds to [Apache Arrow](https://arrow.apache.org/) in-memory query engine [DataFusion](https://github.com/apache/datafusion).
2626

2727
DataFusion's Python bindings can be used as a foundation for building new data systems in Python. Here are some examples:
2828

2929
- [Dask SQL](https://github.com/dask-contrib/dask-sql) uses DataFusion's Python bindings for SQL parsing, query
3030
planning, and logical plan optimizations, and then transpiles the logical plan to Dask operations for execution.
31-
- [DataFusion Ballista](https://github.com/apache/arrow-ballista) is a distributed SQL query engine that extends
31+
- [DataFusion Ballista](https://github.com/apache/datafusion-ballista) is a distributed SQL query engine that extends
3232
DataFusion's Python bindings for distributed use cases.
3333

3434
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.
120120

121121
### Executing Queries with DataFusion
122122

123-
- [Query a Parquet file using SQL](./examples/sql-parquet.py)
124-
- [Query a Parquet file using the DataFrame API](./examples/dataframe-parquet.py)
125-
- [Run a SQL query and store the results in a Pandas DataFrame](./examples/sql-to-pandas.py)
126-
- [Run a SQL query with a Python user-defined function (UDF)](./examples/sql-using-python-udf.py)
127-
- [Run a SQL query with a Python user-defined aggregation function (UDAF)](./examples/sql-using-python-udaf.py)
128-
- [Query PyArrow Data](./examples/query-pyarrow-data.py)
129-
- [Create dataframe](./examples/import.py)
130-
- [Export dataframe](./examples/export.py)
123 8000 +
- [Query a Parquet file using SQL](https://github.com/apache/datafusion-python/blob/main/examples/sql-parquet.py)
124+
- [Query a Parquet file using the DataFrame API](https://github.com/apache/datafusion-python/blob/main/examples/dataframe-parquet.py)
125+
- [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)
126+
- [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)
127+
- [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)
128+
- [Query PyArrow Data](https://github.com/apache/datafusion-python/blob/main/examples/query-pyarrow-data.py)
129+
- [Create dataframe](https://github.com/apache/datafusion-python/blob/main/examples/import.py)
130+
- [Export dataframe](https://github.com/apache/datafusion-python/blob/main/examples/export.py)
131131

132132
### Running User-Defined Python Code
133133

134-
- [Register a Python UDF with DataFusion](./examples/python-udf.py)
135-
- [Register a Python UDAF with DataFusion](./examples/python-udaf.py)
134+
- [Register a Python UDF with DataFusion](https://github.com/apache/datafusion-python/blob/main/examples/python-udf.py)
135+
- [Register a Python UDAF with DataFusion](https://github.com/apache/datafusion-python/blob/main/examples/python-udaf.py)
136136

137137
### Substrait Support
138138

139-
- [Serialize query plans using Substrait](./examples/substrait.py)
139+
- [Serialize query plans using Substrait](https://github.com/apache/datafusion-python/blob/main/examples/substrait.py)
140140

141141
## How to install (from pip)
142142

@@ -172,7 +172,7 @@ Bootstrap (Conda):
172172

173173
```bash
174174
# fetch this repo
175-
git clone git@github.com:apache/arrow-datafusion-python.git
175+
git clone git@github.com:apache/datafusion-python.git
176176
# create the conda environment for dev
177177
conda env create -f ./conda/environments/datafusion-dev.yaml -n datafusion-dev
178178
# activate the conda environment
@@ -183,7 +183,7 @@ Bootstrap (Pip):
183183

184184
```bash
185185
# fetch this repo
186-
git clone git@github.com:apache/arrow-datafusion-python.git
186+
git clone git@github.com:apache/datafusion-python.git
187187
# prepare development environment (used to build wheel / install in development)
188188
python3 -m venv venv
189189
# activate the venv

‎docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
# DataFusion Documentation
2121

2222
This folder contains the source content of the [Python API](./source/api).
23-
This is published to https://arrow.apache.org/datafusion-python/ by a GitHub action
23+
This is published to https://datafusion.apache.org/python by a GitHub action
2424
when changes are merged to the main branch.
2525

2626
## Dependencies
@@ -66,15 +66,15 @@ firefox build/html/index.html
6666
6767
## Release Process
6868
69-
This documentation is hosted at https://arrow.apache.org/datafusion-python/
69+
This documentation is hosted at https://datafusion.apache.org/python
7070
7171
When the PR is merged to the `main` branch of the DataFusion
72-
repository, a [github workflow](https://github.com/apache/arrow-datafusion-python/blob/main/.github/workflows/docs.yaml) which:
72+
repository, a [github workflow](https://github.com/apache/datafusion-python/blob/main/.github/workflows/docs.yaml) which:
7373
7474
1. Builds the html content
75-
2. Pushes the html content to the [`asf-site`](https://github.com/apache/arrow-datafusion-python/tree/asf-site) branch in this repository.
75+
2. Pushes the html content to the [`asf-site`](https://github.com/apache/datafusion-python/tree/asf-site) branch in this repository.
7676
7777
The Apache Software Foundation provides https://arrow.apache.org/,
7878
which serves content based on the configuration in
79-
[.asf.yaml](https://github.com/apache/arrow-datafusion-python/blob/main/.asf.yaml),
80-
which specifies the target as https://arrow.apache.org/datafusion-python/.
79+
[.asf.yaml](https://github.com/apache/datafusion-python/blob/main/.asf.yaml),
80+
which specifies the target as https://datafusion.apache.org/python.

‎docs/source/_static/images/2x_bgwhite_original.png

59 KB
Loading

‎docs/source/_static/images/DataFusion-Logo-Background-White.png

-12.1 KB
Binary file not shown.

‎docs/source/_static/images/DataFusion-Logo-Background-White.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/source/_static/images/DataFusion-Logo-Dark.png

-19.7 KB
Binary file not shown.

‎docs/source/_static/images/DataFusion-Logo-Dark.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎docs/source/_static/images/DataFusion-Logo-Light.png

-18.7 KB
Binary file not shown.

0 commit comments

Comments
 (0)
0