diff --git a/README.md b/README.md index 006964c..63b8860 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Interactive Tables +![ITables Logo](itables/logo/wide.svg) ![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main) [![codecov.io](https://codecov.io/github/mwouts/itables/coverage.svg?branch=main)](https://codecov.io/github/mwouts/itables?branch=main) @@ -7,8 +7,6 @@ [![pyversions](https://img.shields.io/pypi/pyversions/itables.svg)](https://pypi.python.org/pypi/itables) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -## Turn your Python DataFrames into Interactive DataTables - This packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks. With `itables` you can display your tables as interactive [DataTables](https://datatables.net/) that you can sort, paginate, scroll or filter. diff --git a/docs/_config.yml b/docs/_config.yml index add33a7..748c067 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -1,6 +1,7 @@ title: Interactive Tables author: Marc Wouts copyright: "2019-2024" +logo: "../itables/logo/logo.svg" execute: execute_notebooks: force sphinx: diff --git a/docs/quick_start.md b/docs/quick_start.md index f44e0d3..bbaabe8 100644 --- a/docs/quick_start.md +++ b/docs/quick_start.md @@ -12,7 +12,7 @@ kernelspec: name: itables --- -# Quick Start +![ITables Logo](../itables/logo/text.svg) ![CI](https://github.com/mwouts/itables/actions/workflows/continuous-integration.yml/badge.svg?branch=main) [![codecov.io](https://codecov.io/github/mwouts/itables/coverage.svg?branch=main)](https://codecov.io/github/mwouts/itables?branch=main) @@ -23,8 +23,6 @@ kernelspec: Star -## Turn your Python DataFrames into Interactive DataTables - This packages changes how Pandas and Polars DataFrames are rendered in Jupyter Notebooks. With `itables` you can display your tables as interactive [DataTables](https://datatables.net/) that you can sort, paginate, scroll or filter. @@ -36,6 +34,8 @@ The `itables` package depends only on `numpy`, `pandas` and `IPython` which you must already have if you work with Pandas in Jupyter (add `polars`, `pyarrow` if you work with Polars DataFrames). +# Quick Start + ## Installation Install the `itables` package with either diff --git a/itables/logo/logo.svg b/itables/logo/logo.svg new file mode 100644 index 0000000..b41ead2 --- /dev/null +++ b/itables/logo/logo.svg @@ -0,0 +1,41 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/itables/logo/text.svg b/itables/logo/text.svg new file mode 100644 index 0000000..2a70b9a --- /dev/null +++ b/itables/logo/text.svg @@ -0,0 +1,13 @@ + + + + ITables + + + + Python DataFrames as + Interactive DataTables + + + diff --git a/itables/logo/wide.svg b/itables/logo/wide.svg new file mode 100644 index 0000000..7ad824a --- /dev/null +++ b/itables/logo/wide.svg @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ITables + + + + Python DataFrames as + Interactive DataTables + + + diff --git a/itables/logo/with_text.svg b/itables/logo/with_text.svg new file mode 100644 index 0000000..40bc27b --- /dev/null +++ b/itables/logo/with_text.svg @@ -0,0 +1,49 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + ITables + + + + Python DataFrames + as Interactive DataTables + + +