'write-a-composition-function-in-python' guide doc doesn't work
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- documentation
Research direction
Start with the guide at https://docs.crossplane.io/latest/guides/write-a-composition-function-in-python/ and reproduce the commands through hatch run development using function-template-python. Check whether the documented example or generated template causes the protobuf warnings and Cannot run function error; done means the example runs successfully or the guide clearly documents the required fix.
Written by the indexing model from the issue text.
Description
URL
https://docs.crossplane.io/latest/guides/write-a-composition-function-in-python/
What's Wrong?
I followed each and every instruction mentioned there from using command 'crossplane xpkg init function-xbuckets https://github.com/crossplane/function-template-python -d function-xbuckets' to create a folder till 'hatch run development' but the example never works.
Errors I get:
function-xbuckets.venv-default\Lib\site-packages\google\protobuf\runtime_version.py:98: UserWarning: Protobuf gencode version 5.29.0 is exactly one major version older than the runtime version 6.31.1 at crossplane/function/proto/v1/run_function.proto. Please update the gencode to avoid compatibility violations in the next runtime release.
warnings.warn(
function-xbuckets.venv-default\Lib\site-packages\google\protobuf\runtime_version.py:98: UserWarning: Protobuf gencode version 5.29.0 is exactly one major version older than the runtime version 6.31.1 at crossplane/function/proto/v1beta1/run_function.proto. Please update the gencode to avoid compatibility violations in the next runtime release.
warnings.warn(
Cannot run function:
I request either update the example or fix the docs.
Also if I am missing something then please let me know. 😁
- Dominant language
- SCSS
- Stars
- 60
- Forks
- 163
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 1
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from crossplane/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
crossplane/docs#1158 ·
-
docs: fix 'allows to use' grammar in Composition compositeTypeRef notePossibly taken @mrchatam claimed this 24 days ago. Open
Difficulty 1/5 Under an hour Newbie friendliness 95/100
crossplane/docs#1154 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
crossplane/docs#1153 ·
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
crossplane/docs#1139 ·
-
[Web Bug] - Managed Resource Activation PoliciesPossibly taken @boxcee-interview claimed this 79 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
crossplane/docs#1126 · 1 comment ·
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 92/100
philchalmers/SimDesign#106 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
Small-tailqwq/dsh-deep-whale#187 ·
Maintainers usually reply within 1 day
-
audit.md numbers Theming and Responsive Design differently in the headings and the score tablePossibly taken @pbakaus claimed this today. Openneeds triage
Difficulty 1/5 Under an hour Newbie friendliness 90/100
pbakaus/impeccable#979 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 90/100
fastrevmd-lab/rustmistmcp#161 ·