docs: Add logo cards for ecosystem projects - #3768
Conversation
|
pretty neat, nice! |
| the [plugins system](/narwhals/extending/) | ||
|
|
||
| The following is a non-exhaustive list of libraries and tools that choose to use Narwhals | ||
| ## Narwhals is Used by |
There was a problem hiding this comment.
Nit: I liked Used By.
I would hope that being on our website was enough context 😉
More useful: is there anything we can do to make the one on the README prettier?
I'm guessing we'd have less choices with than zensical, but a grid would be nice there too
Is there a preference between storing logos in our GH repo, or just serving them from the project GH (current)?
I imagine at least having the links centralized would help with using them here
Consider that a project may move their logo within their own repo, and now that logo no longer renders correctly
I think t There are linters you can run in ci for dead links in docs (can't recall any though 🫣)
Updated: found the one I was thinking of (https://github.com/lycheeverse/lychee/)!
| - name: Altair | ||
| homepage: https://narwhals-dev.github.io/narwhals/ | ||
| logo: https://altair-viz.github.io/_static/altair-logo-light.png |
There was a problem hiding this comment.
We were one of the first big projects to adopt Narwhals.
But I'm pretty sure there wasn't a reverse hostile takeover
| - name: Altair | |
| homepage: https://narwhals-dev.github.io/narwhals/ | |
| logo: https://altair-viz.github.io/_static/altair-logo-light.png | |
| - name: Altair | |
| homepage: https://altair-viz.github.io/ | |
| logo: https://altair-viz.github.io/_static/altair-logo-light.png |
| margin: 0.75rem auto 1rem; | ||
| border: 0; | ||
| border-top: 1px solid var(--md-default-fg-color--light); | ||
| opacity: 0.6;} |
There was a problem hiding this comment.
This was a format on save for me, but why not make it a suggestion instead?
| opacity: 0.6;} | |
| opacity: 0.6; | |
| } |
| @@ -0,0 +1,74 @@ | |||
| .project-grid { | |||
There was a problem hiding this comment.
I haven't worked out where we put it yet, but we need to make some changes for dark mode
But finding the right one requires some homework:
There was a problem hiding this comment.
I played around with the css and there isn't a universal solution. Instead, I think I will check if the project has a "dark-mode" logo and set up some JS to toggle between to the correct image.
If a project doesn't have a dark-mode logo counterpart then we'll get as far as possible with some css.
There was a problem hiding this comment.
@dangotbanned how is this looking now? I grabbed dark-mode logos where available and for any projects that did not have one, I gave them a slightly lighter background when dark mode was toggled on.
| [project.markdown_extensions.zensical.extensions.macros] | ||
| include_dir = "docs/includes" | ||
|
|
||
| [project.markdown_extensions.zensical.extensions.macros.include_yaml] | ||
| projects = "docs/data/projects.yml" |
There was a problem hiding this comment.
Just a little grouping together.
It wasn't obvious to me before that this was a fancy zensical extension
| [project.markdown_extensions.zensical.extensions.macros] | |
| include_dir = "docs/includes" | |
| [project.markdown_extensions.zensical.extensions.macros.include_yaml] | |
| projects = "docs/data/projects.yml" | |
| [project.markdown_extensions.zensical.extensions] | |
| macros = { include_dir = "docs/includes", include_yaml = { projects = "docs/data/projects.yml" } } |
| If you would like to chat with us, or if you need any support, please [join our Discord server](https://discord.gg/V3PqtB4VA4). | ||
|
|
||
| ## Related projects | ||
| ## Directly Supported Tabular Data Packages |
There was a problem hiding this comment.
Just pinging @FBruzzesi, as this reminded me of (#3794 (comment))
Directly Supported Tabular Data Packages
Nothing about this is wrong or inaccurate.
But I do think it is helpful when we use consistent terms 🙂
A future PR could Add a glossary - which is something I really like about the python docs.
In this PR, what do you think about referring to these as backends?
Side note
I've been using Plugin and Builtin as the names of protocols here
This isn't a 1-to-1 with main, nor a suggestion - just giving an example 😅
narwhals/src/narwhals/_plan/compliant/plugins.py
Lines 158 to 164 in 0f9a88e
There was a problem hiding this comment.
I like this, changed to ## Builtins: Directly Supported Tabular Data Packages and ## Plugins: Externally Supported Tabular Data Packages
Also contemplating swapping the phrasing "Tabular Data Packages" for "Tabular Data Tools"



Description
Wanted to get a "good enough" PR up, let me know what you think!
Summary:
TO Do/Discuss:
Screenshots
3.5k px width
2k px width
Standard Mobile Device (Iphone SE; 375px width)
What type of PR is this? (check all applicable)
Related issues
AI assistance
Checklist
Code follows style guide (ruff)
Tests added
Documented the changes
If this is your first PR to narwhals, attach a screenshot of
pytestpassing locally (not CI):