Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix README to show graphics on PyPI #2961

Merged
merged 9 commits into from
Aug 23, 2023
Merged

Fix README to show graphics on PyPI #2961

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f2d54e9
Fix for PyPI
stichbury Aug 22, 2023
adb2dd6
Merge branch 'main' into revise-readme-for-pypi
stichbury Aug 22, 2023
c987f19
Merge branch 'main' into revise-readme-for-pypi
stichbury Aug 22, 2023
f00aea7
Few more tweaks
stichbury Aug 23, 2023
9d8900b
Few more tweaks
stichbury Aug 23, 2023
2333474
Few more tweaks
stichbury Aug 23, 2023
7958068
Few more tweaks
stichbury Aug 23, 2023
c7f1477
Update README.md
stichbury Aug 23, 2023
b630db5
Update README.md
stichbury Aug 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
![Kedro Logo Banner - Light](.github/demo-dark.png#gh-dark-mode-only)
![Kedro Logo Banner - Dark](.github/demo-light.png#gh-light-mode-only)
![Kedro Logo Banner - Light](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-dark.png#gh-dark-mode-only)
![Kedro Logo Banner - Dark](https://raw.githubusercontent.com/kedro-org/kedro/main/.github/demo-light.png#gh-light-mode-only)
[![Python version](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue.svg)](https://pypi.org/project/kedro/)
[![PyPI version](https://badge.fury.io/py/kedro.svg)](https://pypi.org/project/kedro/)
[![Conda version](https://img.shields.io/conda/vn/conda-forge/kedro.svg)](https://anaconda.org/conda-forge/kedro)
Expand Down Expand Up @@ -37,9 +37,6 @@ Our [Get Started guide](https://docs.kedro.org/en/stable/get_started/install.htm

## What are the main features of Kedro?

![Kedro-Viz Pipeline Visualisation](https://github.com/kedro-org/kedro-viz/blob/main/.github/img/banner.png)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sad about seeing this image go though, it's arguably one of the things that hook people to Kedro 😇 I know it's technically part of Kedro Viz but if we consider Framework as the center of the ecosystem, maybe it makes sense to keep it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I can reinstate but I will reorganise the content slightly as it wasn't in the right place in the narrative.

I think I have a problem with these graphics as they're very dark and not the easiest to read/interpret but if there's evidence they encourage uptake, it's probably just me, and let's keep it.

_A pipeline visualisation generated using [Kedro-Viz](https://github.com/kedro-org/kedro-viz)_

| Feature | What is this? |
| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Project Template | A standard, modifiable and easy-to-use project template based on [Cookiecutter Data Science](https://github.com/drivendata/cookiecutter-data-science/). |
Expand All @@ -54,7 +51,15 @@ The [Kedro documentation](https://docs.kedro.org/en/stable/) first explains [how

You can then review the [spaceflights tutorial](https://docs.kedro.org/en/stable/tutorial/spaceflights_tutorial.html) to build a Kedro project for hands-on experience

For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html) and [how to work with Kedro and Jupyter notebooks](https://docs.kedro.org/en/stable/notebooks_and_ipython/index.html). We also recommend the [API reference documentation](/kedro) for additional information.
For new and intermediate Kedro users, there's a comprehensive section on [how to visualise Kedro projects using Kedro-Viz](https://docs.kedro.org/en/stable/visualisation/index.html).


<p align="center">
<img src="https://raw.githubusercontent.com/kedro-org/kedro-viz/main/.github/img/banner.png" alt>
<em>A pipeline visualisation generated using Kedro-Viz</em>
</p>

Additional documentation explains [how to work with Kedro and Jupyter notebooks](https://docs.kedro.org/en/stable/notebooks_and_ipython/index.html), and there are a set of advanced user guides for advanced for key Kedro features. We also recommend the [API reference documentation](/kedro) for further information.


## Why does Kedro exist?
Expand Down