Skip to content

docs: add Custom Python component documentation#888

Open
MonikaFeigler wants to merge 6 commits intomainfrom
devin/1773929518-custom-python-docs
Open

docs: add Custom Python component documentation#888
MonikaFeigler wants to merge 6 commits intomainfrom
devin/1773929518-custom-python-docs

Conversation

@MonikaFeigler
Copy link
Copy Markdown
Contributor

@MonikaFeigler MonikaFeigler commented Mar 19, 2026

Jira issue(s): PROOF-XXX (to be created)

Changes:

  • Add new documentation page for the Custom Python application at /components/applications/custom-python/
  • Add navigation entry under Components → Applications
  • Add 5 UI screenshots covering the component overview, Python version selection, inline code editor, User Parameters, and Git repository configuration
  • Add "Using Kai to Configure Custom Python" section with example prompts and a tip for getting better results from Kai (addresses review feedback from @jordanrburger)

Content is sourced from the component-custom-python README and covers:

  • Comparison to Python Transformations
  • Configuration parameters (Python version, source, Git settings, user parameters)
  • Code example using CommonInterface
  • Git repository integration with dependency management (pyproject.toml/uv.lock vs requirements.txt)
  • How Kai can help configure, generate code for, and troubleshoot the component

Notes for reviewer

  • Verify the example repo link is publicly accessible.
  • Kai section — Please verify the described capabilities (code generation, credential configuration, Git setup, job troubleshooting) accurately reflect what Kai can do today with Custom Python.
  • No redirect_from in front matter — intentional since this is a new page with no legacy URL.

Release Notes

Justification, description

New user documentation for the Custom Python component (application), enabling users to find guidance on configuring and using the component directly from help.keboola.com. Includes a section highlighting Kai as an AI-assisted way to configure the component.

Plans for Customer Communication

N/A

Impact Analysis

Documentation-only change. No functional impact.

Deployment Plan

Standard merge to main — auto-deployed via Jekyll build.

Rollback Plan

Revert the merge commit.

Post-Release Support Plan

N/A

Link to Devin session: https://app.devin.ai/sessions/f084e35d727b42c2843b39ebf5d91988
Requested by: @MonikaFeigler


Open in Devin Review

Co-Authored-By: Monika Feigler <monika@feigler.cz>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

Summary

  • Add new documentation page for the Custom Python application at /components/applications/custom-python/
  • Add navigation entry under Components → Applications
  • Rewrote content to be user-facing rather than developer-facing: replaced 9 code examples with a single minimal snippet and a link to developer docs,
    removed raw JSON configuration examples, removed JSON parameter key names from UI field descriptions
  • Added 5 UI screenshots covering the component overview, Python version selection, inline code editor, User Parameters, and Git repository configuration

@MonikaFeigler MonikaFeigler marked this pull request as ready for review March 19, 2026 14:49
@MonikaFeigler MonikaFeigler requested a review from kudj March 19, 2026 14:49
@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

@kudj can you please review this docs for custom python please?

Copy link
Copy Markdown
Contributor

@jordanrburger jordanrburger left a comment

Choose a reason for hiding this comment

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

It would be great to have a note on this page about the possibility of configuring the custom python component easily with Kai.

Copy link
Copy Markdown
Contributor Author

MonikaFeigler commented Apr 2, 2026

@jordan.burger great comment. I added the section. Thanks.

Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Added a new "Using Kai to Configure Custom Python" section (commit aa4cdf9) that covers:

  • Example prompts for creating configurations, setting up integrations, and debugging jobs
  • Description of what Kai can do with the Custom Python component (code generation, credential configuration, Git setup, troubleshooting)
  • A tip encouraging users to be specific with their requests for better results

Please review and let me know if the scope/tone fits what you had in mind!

@MonikaFeigler MonikaFeigler enabled auto-merge April 20, 2026 10:25
@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

@kudj can you please review?

@devin-ai-integration
Copy link
Copy Markdown
Contributor

❌ Cannot revive Devin session - the session is too old. Please start a new session instead.

@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

@soustruh review please.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants