Skip to content

Commit

Permalink
Merge commit 'af8b37fbaaec770fb1fdee406f8007df5c4f978b' into docs/add…
Browse files Browse the repository at this point in the history
…-asset-bundles-deployment

Signed-off-by: erwinpaillacan <[email protected]>
  • Loading branch information
erwinpaillacan committed Jun 20, 2024
2 parents 95e604a + af8b37f commit ae623fb
Show file tree
Hide file tree
Showing 73 changed files with 1,683 additions and 573 deletions.
1 change: 1 addition & 0 deletions .github/styles/Kedro/ignore-names.txt
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ Paricio
Patel
Peteris
Pilla
Puneet
Rashida
Ravi
Richard
Expand Down
12 changes: 8 additions & 4 deletions .github/workflows/check-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,12 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install uv
run: |
python -m pip install "uv==0.1.32"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install requests
uv pip install --system requests
- name: Check version
run: python tools/github_actions/github_actions_release.py
- name: Set outputs
Expand Down Expand Up @@ -48,10 +50,12 @@ jobs:
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install uv
run: |
python -m pip install "uv==0.1.32"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build
uv pip install --system build
- name: Build package
run: make package
- name: Extract release notes from RELEASE.md
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/e2e-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ jobs:
- name: Install dependencies
run: |
pip install --upgrade pip
make install-test-requirements
pip install -U .[test]
make install-pre-commit
- name: pip freeze
run: pip freeze
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,6 @@ jobs:
make install-test-requirements
make install-pre-commit
- name: pip freeze
run: pip freeze
run: uv pip freeze --system
- name: Run linter
run: make lint
2 changes: 1 addition & 1 deletion .github/workflows/pip-compile.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ jobs:
run: |
make install-test-requirements
make install-pre-commit
pip install "pip-tools>=6.5"
uv pip install --system "pip-tools>=6.5"
- name: Run pip-compile
run: make pip-compile
2 changes: 1 addition & 1 deletion .github/workflows/unit-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ jobs:
make install-test-requirements
make install-pre-commit
- name: pip freeze
run: pip freeze
run: uv pip freeze --system
- name: Run unit tests
run: make test
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@

tmp/
# CMake
cmake-build-debug/

Expand Down
12 changes: 0 additions & 12 deletions .gitpod.Dockerfile

This file was deleted.

13 changes: 9 additions & 4 deletions .gitpod.yml
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
image:
file: .gitpod.Dockerfile
image: gitpod/workspace-python-3.11

tasks:
- name: kedro

init: |
make sign-off
pip install -e /workspace/kedro[test]
pip install uv
uv venv
source .venv/bin/activate
uv pip install -e /workspace/kedro[test]
cd /workspace
kedro new --name project -s spaceflights-pandas --checkout main
pip install -e project
uv pip install -e project
cd /workspace/kedro
pre-commit install --install-hooks
command: |
clear
source .venv/bin/activate
kedro info
github:
prebuilds:
# enable for the master/default branch (defaults to true)
Expand Down
9 changes: 4 additions & 5 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,13 @@ authors:
given-names: Joel
- family-names: Sorokin
given-names: Dmitry
- family-names: Stichbury
given-names: Jo
orcid: https://orcid.org/0000-0002-7474-4024
- family-names: Theisen
given-names: Merel
- family-names: Zabłocki
given-names: Marcin
- family-names: Brugman
given-names: Simon
title: Kedro
version: 0.19.3
date-released: 2024-02-27
version: 0.19.5
date-released: 2024-04-22
url: https://github.com/kedro-org/kedro
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
install:
pip install -e .
uv pip install --system -e .

clean:
rm -rf build dist docs/build kedro/html pip-wheel-metadata .mypy_cache .pytest_cache features/steps/test_plugin/test_plugin.egg-info
Expand Down Expand Up @@ -31,22 +31,22 @@ secret-scan:
trufflehog --max_depth 1 --exclude_paths trufflehog-ignore.txt .

build-docs:
pip install -e ".[docs]"
uv pip install --system -e ".[docs]"
./docs/build-docs.sh "docs"

show-docs:
open docs/build/html/index.html

linkcheck:
pip install -e ".[docs]"
uv pip install --system "kedro[docs] @ ."
./docs/build-docs.sh "linkcheck"

package: clean install
python -m pip install build && python -m build

install-test-requirements:
python -m pip install -U "pip>=21.2"
pip install .[test]
python -m pip install "uv==0.1.32"
uv pip install --system "kedro[test] @ ."

install-pre-commit:
pre-commit install --install-hooks
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![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.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue.svg)](https://pypi.org/project/kedro/)
[![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-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)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/kedro-org/kedro/blob/main/LICENSE.md)
Expand Down
45 changes: 40 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,58 @@
# Upcoming Release 0.19.4
# Upcoming Release 0.19.6

## Major features and improvements

## Bug fixes and other changes

## Breaking changes to the API

## Documentation changes

## Community contributions


# Release 0.19.5

## Bug fixes and other changes
* Fixed breaking import issue when working on a project with `kedro-viz` on python 3.8.

## Documentation changes
* Updated the documentation for deploying a Kedro project with Astronomer Airflow.
* Used `kedro-sphinx-theme` for documentation.

# Release 0.19.4

## Major features and improvements
* Improved error message when passing wrong value to node.
* Cookiecutter errors are shown in short format without the `--verbose` flag.
* Kedro commands now work from any subdirectory within a Kedro project.
* Kedro CLI now provides a better error message when project commands are run outside of a project i.e. `kedro run`.
* Kedro CLI now provides a better error message when project commands are run outside of a project i.e. `kedro run`
* Added the `--telemetry` flag to `kedro new`, allowing the user to register consent to have user analytics collected at the same time as the project is created.
* Improved the performance of `Pipeline` object creation and summing.
* Improved suggestions to resume failed pipeline runs.
* Dropped the dependency on `toposort` in favour of the built-in `graphlib` module.
* Improve the performance of `Pipeline` object creation and summing.
* Cookiecutter errors are shown in short format without the `--verbose` flag.

## Bug fixes and other changes
* Updated `kedro pipeline create` and `kedro pipeline delete` to read the base environment from the project settings.
* Updated CLI command `kedro catalog resolve` to read credentials properly.
* Changed the path of where pipeline tests generated with `kedro pipeline create` from `<project root>/src/tests/pipelines/<pipeline name>` to `<project root>/tests/pipelines/<pipeline name>`.
* Updated ``.gitignore`` to prevent pushing Mlflow local runs folder to a remote forge when using mlflow and git.
* Fixed error handling message for malformed yaml/json files in OmegaConfigLoader.
* Fixed a bug in `node`-creation allowing self-dependencies when using transcoding, that is datasets named like `name@format`.
* Improved error message when passing wrong value to node.

## Breaking changes to the API
* Methods `_is_project` and `_find_kedro_project` have been moved to `kedro.utils`. We recommend not using private methods in your code, but if you do, please update your code to use the new location.

## Documentation changes
* Added missing description for `merge_strategy` argument in OmegaConfigLoader.
* Added documentation on best practices for testing nodes and pipelines.
* Clarified docs around using custom resolvers without a full Kedro project.

## Community contributions
Many thanks to the following Kedroids for contributing PRs to this release:

* [ondrejzacha](https://github.com/ondrejzacha)
* [Puneet](https://github.com/puneeter)

# Release 0.19.3

Expand Down
73 changes: 0 additions & 73 deletions docs/source/_templates/layout.html

This file was deleted.

43 changes: 5 additions & 38 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
from __future__ import annotations

import importlib
import os
import re
import sys
from inspect import getmembers, isclass, isfunction
Expand Down Expand Up @@ -202,7 +201,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
html_theme = "kedro-sphinx-theme"
here = Path(__file__).parent.absolute()

# Theme options are theme-specific and customise the look and feel of a theme
Expand Down Expand Up @@ -239,13 +238,12 @@
"https://opensource.org/license/apache2-0-php/",
"https://docs.github.com/en/rest/overview/other-authentication-methods#via-username-and-password",
"https://www.educative.io/blog/advanced-yaml-syntax-cheatsheet#anchors",
# temporarily, until the file actually exists in `main`
"https://github.com/kedro-org/kedro/blob/main/kedro/templates/project/%7B%7B%20cookiecutter.repo_name%20%7D%7D/.flake8",
"https://www.quora.com/What-is-thread-safety-in-Python", # "403 Client Error: Forbidden for url"
]

# retry before render a link broken (fix for "too many requests")
linkcheck_retries = 5
linkcheck_rate_limit_timeout = 2.0
# Comment out settings to fix Client Rate Limit Error 429
linkcheck_retries = 3
# linkcheck_rate_limit_timeout = 2.0

html_context = {
"display_github": True,
Expand Down Expand Up @@ -493,39 +491,8 @@ def autodoc_process_docstring(app, what, name, obj, options, lines): # noqa: PL
remove_arrows_in_examples(lines)


def env_override(default_appid):
build_version = os.getenv("READTHEDOCS_VERSION")

if build_version == "latest":
return os.environ["HEAP_APPID_QA"]
if build_version == "stable":
return os.environ["HEAP_APPID_PROD"]

return default_appid # default to Development for local builds


def _add_jinja_filters(app):
# https://github.com/crate/crate/issues/10833
from sphinx.builders.latex import LaTeXBuilder
from sphinx.builders.linkcheck import CheckExternalLinksBuilder

# LaTeXBuilder is used in the PDF docs build,
# and it doesn't have attribute 'templates'
if not (isinstance(app.builder, (LaTeXBuilder, CheckExternalLinksBuilder))):
app.builder.templates.environment.filters["env_override"] = env_override


def _override_permalinks_icon(app):
# https://github.com/readthedocs/sphinx_rtd_theme/issues/98#issuecomment-1503211439
app.config.html_permalinks_icon = "¶"


def setup(app):
app.connect("builder-inited", _add_jinja_filters)
app.connect("builder-inited", _override_permalinks_icon)
app.connect("autodoc-process-docstring", autodoc_process_docstring)
# fix a bug with table wraps in Read the Docs Sphinx theme:
# https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html


# (regex, restructuredText link replacement, object) list
Expand Down
Loading

0 comments on commit ae623fb

Please sign in to comment.