Skip to content

docs: add Custom Python component documentation#888

Merged
MonikaFeigler merged 7 commits intomainfrom
devin/1773929518-custom-python-docs
Apr 29, 2026
Merged

docs: add Custom Python component documentation#888
MonikaFeigler merged 7 commits intomainfrom
devin/1773929518-custom-python-docs

Conversation

@MonikaFeigler
Copy link
Copy Markdown
Contributor

@MonikaFeigler MonikaFeigler commented Mar 19, 2026 •
edited by devin-ai-integration Bot
Loading

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)
  • Updated Python version screenshot and text: Python 3.14 is now the recommended choice (previously 3.13), and the "release candidate" label has been removed from Python 3.14

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.

Link to Devin session: https://app.devin.ai/sessions/5b86fb6f0d9e47ce8aaf13673eb412ac
Requested by: @soustruh

Open in Devin Review

@devin-ai-integration @MonikaFeigler
docs: add Custom Python component documentation
81a11d5 
Co-Authored-By: Monika Feigler <monika@feigler.cz>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

devin-ai-integration Bot commented Mar 19, 2026

🤖 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

MonikaFeigler commented Mar 19, 2026

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

MonikaFeigler commented Mar 19, 2026

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

jordanrburger
jordanrburger reviewed Mar 23, 2026
View reviewed changes
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.

@MonikaFeigler Linear
Copy link
Copy Markdown
Contributor Author

MonikaFeigler commented Apr 2, 2026 •
edited
Loading

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

devin-ai-integration[bot]
devin-ai-integration Bot reviewed Apr 20, 2026
View reviewed changes
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

devin-ai-integration Bot commented Apr 20, 2026

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

MonikaFeigler commented Apr 20, 2026

@kudj can you please review?

@devin-ai-integration
Copy link
Copy Markdown
Contributor

devin-ai-integration Bot commented Apr 20, 2026

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

@MonikaFeigler
Copy link
Copy Markdown
Contributor Author

MonikaFeigler commented Apr 23, 2026

@soustruh review please.

MonikaFeigler and others added 2 commits April 23, 2026 14:51
@MonikaFeigler
Merge branch 'main' into devin/1773929518-custom-python-docs
76fdcdb
@devin-ai-integration @soustruh
docs: update Python version screenshot and text for Custom Python
6a22530 
- Python 3.14 is now the recommended choice (was 3.13)
- Removed 'release candidate' label from Python 3.14
- Updated screenshot to reflect current UI

Co-Authored-By: martin.struzsky <martin@struzsky.cz>
soustruh
soustruh approved these changes Apr 29, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@soustruh soustruh left a comment

Choose a reason for hiding this comment

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

LGTM! ദ്ദി(•ᴗ•)

@MonikaFeigler MonikaFeigler merged commit 167009d into main Apr 29, 2026
1 check passed
@MonikaFeigler MonikaFeigler deleted the devin/1773929518-custom-python-docs branch April 29, 2026 00:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jordanrburger jordanrburger jordanrburger left review comments

@devin-ai-integration devin-ai-integration[bot] devin-ai-integration[bot] left review comments

@soustruh soustruh soustruh approved these changes

@kudj kudj Awaiting requested review from kudj

Assignees

@MonikaFeigler MonikaFeigler

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@MonikaFeigler @soustruh @jordanrburger