Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create how to on custom local components #343

Merged
merged 4 commits into from Oct 6, 2022
Merged

Conversation

droumis
Copy link
Member

@droumis droumis commented Sep 30, 2022

  • import a component by its module path, e.g. you can do my_library.some_module.MyTransform

  • Also made the install page more explicit about python installation after a good talk with @Hoxbro.

  • Also included some minor fixes like syntax highlighting and a couple of links

127 0 0 1_5500_docs__build_html_how_to_local_components html (1)

@codecov-commenter
Copy link

codecov-commenter commented Sep 30, 2022

Codecov Report

Merging #343 (bbfbcbd) into master (95b3e7d) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #343   +/-   ##
=======================================
  Coverage   67.22%   67.22%           
=======================================
  Files          71       71           
  Lines        7340     7340           
=======================================
  Hits         4934     4934           
  Misses       2406     2406           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@maximlt
Copy link
Member

maximlt commented Sep 30, 2022

Maybe this is still WIP but shouldn't this How-to actually describe how to write the code of a custom compoment? I.e. you have to create a class that inherits from a base class, you have to define transform_type to define the name by which you will be referring to that component in the spec, you have to implement the apply method with this signature and returning that type of object, create Parameters, specify _field_params, etc.

@droumis
Copy link
Member Author

droumis commented Oct 3, 2022

@maximlt, according to the plan by @philippjfr , there are separate how-to guides planned for

  • Build a Custom Source
  • Build a Custom Filter
  • Build a Custom Transform
  • Build a Custom View

This PR is much simpler and is intended just to cover how to use those components, once created.

@philippjfr
Copy link
Member

philippjfr commented Oct 3, 2022

Yeah, let's keep that separate. However one thing that wasn't documented elsewhere and should be here is that you can import a component by its module path, e.g. you can do my_library.some_module.MyTransform.

@droumis
Copy link
Member Author

droumis commented Oct 5, 2022

@philippjfr can we merge this now?

@philippjfr philippjfr merged commit b0a6a35 into master Oct 6, 2022
@philippjfr philippjfr deleted the howto_local_components branch October 6, 2022 10:56
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 11, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants