Skip to content

Commit

Permalink
Add custom lakeFS-spec logo/favicon (#238)
Browse files Browse the repository at this point in the history
* docs: Delete outdated Use Cases page

* assets: Add raw logo (Inkscape SVG)

* docs: Add logo and favicon

* docs: Add logo to GH/PyPI readme

The dark/light mode switch using the HTML `<picture>` element with a
media query should be compatible with PyPI's description renderer,
based a my short experimentation.

* chore: Rename assets folder

* docs: Move badges below logo in README

* docs: Move badges below headline in README
  • Loading branch information
AdrianoKF authored Dec 22, 2023
1 parent 946da5e commit 813b386
Show file tree
Hide file tree
Showing 10 changed files with 334 additions and 114 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
[![](https://img.shields.io/pypi/v/lakefs-spec)](https://pypi.org/project/lakefs-spec) ![GitHub](https://img.shields.io/github/license/aai-institute/lakefs-spec) [![docs](https://img.shields.io/badge/docs-latest-blue)](https://lakefs-spec.org)
![GitHub](https://img.shields.io/github/stars/aai-institute/lakefs-spec)
<picture>
<source media="(prefers-color-scheme: dark)" srcset="docs/_images/lakefs-spec-logo-light.png">
<img alt="lakeFS-spec logo" src="docs/_images/lakefs-spec-logo-dark.png">
</picture>

# lakeFS-spec: An fsspec backend for lakeFS

[![](https://img.shields.io/pypi/v/lakefs-spec)](https://pypi.org/project/lakefs-spec) ![GitHub](https://img.shields.io/github/license/aai-institute/lakefs-spec) [![docs](https://img.shields.io/badge/docs-latest-blue)](https://lakefs-spec.org)
![GitHub](https://img.shields.io/github/stars/aai-institute/lakefs-spec)

Welcome to lakeFS-spec, a [filesystem-spec](https://github.com/fsspec/filesystem_spec) backend implementation for the [lakeFS](https://lakefs.io/) data lake.
Our primary goal is to streamline versioned data operations in lakeFS, enabling seamless integration with popular data science tools such as Pandas, Polars, and DuckDB directly from Python.

Expand Down
296 changes: 296 additions & 0 deletions assets/lakefs-spec-logo-all.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/lakefs-spec-favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/lakefs-spec-logo-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/lakefs-spec-logo-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions docs/_styles/extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,21 @@ code>.err:first-of-type {
display: none;
}

/* Hide empty root heading (-> `#`) */
h1#_1 {
display: none;
}

.logo {
/* No wider than the screen on smaller screens */
max-width: min(100%, 100vw) !important;
max-height: 196px;

/* Horizontally centered */
display: block;
margin: 0 auto;
}

table {
display: block;
max-width: -moz-fit-content;
Expand Down
6 changes: 6 additions & 0 deletions docs/_styles/theme.css
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,12 @@
--md-code-font-family: "Source Code Pro", monospace
}

[data-md-color-scheme="aai-light"] img[src$="#only-dark"],
[data-md-color-scheme="aai-light"] img[src$="#gh-dark-mode-only"] {
display: none;
/* Hide dark images in light mode */
}

.md-header {
background: rgb(24, 165, 167);
background: linear-gradient(30deg, rgb(24, 165, 167), 90%, rgb(191, 255, 199));
Expand Down
15 changes: 8 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# lakefs-spec: An fsspec backend for lakeFS
#

!!! tip "Early Adopters"
We are seeking early adopters who would like to actively participate in our feedback process and shape the future of the library.
If you are interested in using the library and want to get in touch with us, please reach out via [Github Discussions](https://github.com/aai-institute/lakefs-spec/discussions){: target="_blank" rel="noopener"}.
![lakeFS-spec logo](_images/lakefs-spec-logo-dark.png#only-light){ class="logo" }
![lakeFS-spec logo](_images/lakefs-spec-logo-light.png#only-dark){ class="logo" }

Welcome to lakeFS-spec, a [filesystem-spec](https://github.com/fsspec/filesystem_spec){: target="_blank" rel="noopener"} backend implementation for the [lakeFS](https://lakefs.io/){: target="_blank" rel="noopener"} data lake.
Our primary goal is to streamline versioned data operations in lakeFS, enabling seamless integration with popular data science tools such as Pandas, Polars, and DuckDB directly from Python.
Expand All @@ -17,7 +16,9 @@ Highlights:
- Smart data transfers through client-side caching (up-/download)
- Auto-discovery configuration

<hr>
!!! tip "Early Adopters"
We are seeking early adopters who would like to actively participate in our feedback process and shape the future of the library.
If you are interested in using the library and want to get in touch with us, please reach out via [Github Discussions](https://github.com/aai-institute/lakefs-spec/discussions){: target="_blank" rel="noopener"}.

::cards:: cols=3

Expand All @@ -27,7 +28,7 @@ Highlights:
url: quickstart.md

- title: Tutorials
content: In-depth tutorials on using lakefs-spec
content: In-depth tutorials on using lakeFS-spec
icon: ":octicons-repo-clone-24:{ .landing-page-icon }"
url: tutorials/index.md

Expand All @@ -37,7 +38,7 @@ Highlights:
url: reference/lakefs_spec/index.md

- title: User Guide
content: Solving specific tasks with lakefs-spec
content: Solving specific tasks with lakeFS-spec
icon: ":octicons-tasklist-24:{ .landing-page-icon }"
url: guides/index.md

Expand Down
Loading

0 comments on commit 813b386

Please sign in to comment.