Skip to content

Add initial project structure for custom component template#1

Merged
bogdankostic merged 13 commits into
mainfrom
custom-component-template
Mar 24, 2026
Merged

Add initial project structure for custom component template#1
bogdankostic merged 13 commits into
mainfrom
custom-component-template

Conversation

@bogdankostic
Copy link
Copy Markdown
Collaborator

Summary

  • Set up a complete project scaffold for creating custom Haystack components as standalone Python packages
  • Added an example component under the haystack_integrations namespace package with a skeleton test file, along with TODO markers throughout to guide users
  • Included CI workflows for testing (Python 3.10 & 3.13, lint via Ruff) and releasing to PyPI on version tags
  • Added a README with step-by-step instructions covering namespace conventions, development commands, and publishing

Copy link
Copy Markdown
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

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

Looks quite good to me already. I have some smaller ideas how to improve but nothing major.

Comment thread .github/workflows/test.yml Outdated
Comment thread .github/workflows/test.yml Outdated
Comment thread src/haystack_integrations/components/example/example_component.py Outdated
Comment thread tests/test_example.py
Comment thread src/haystack_integrations/components/example/example_component.py
Comment thread pyproject.toml
Comment thread pyproject.toml
Comment thread pyproject.toml Outdated
Comment thread README.md

## How to use this template

1. Click **[Use this template](https://github.com/deepset-ai/custom-component/generate)** to create a new repository.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Once you worked with loom, maybe it's a good idea to also record a video of this step and the other ToDos? 🙂

Copy link
Copy Markdown
Member

@julian-risch julian-risch left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@bogdankostic bogdankostic merged commit 4aa344a into main Mar 24, 2026
2 checks passed
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