Skip to content

Add documentation on extending #1301

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

Open
wants to merge 3 commits into
base: 3.x
Choose a base branch
from

Conversation

goetzk
Copy link
Contributor

@goetzk goetzk commented Feb 24, 2025

While working on my custom stuff I gathered up my notes (and will likely gather more).
I haven't worked with custom facts or operations yet so haven't put anything in those sections but if I do (eg for #1288) I'd be able to expand this further.

@Fizzadar Would this sort of information be useful if I rounded out the page created in this commit? Would you like the information, but rather it was placed somewhere else in the documentation?

its bare bones, but means I've written _something_
Copy link
Member

@Fizzadar Fizzadar left a comment

Choose a reason for hiding this comment

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

I need to think about where this fits in, there's a lot of overlap with the contributing doc: https://docs.pyinfra.com/en/3.x/contributing.html, might be best to expand there?

@goetzk
Copy link
Contributor Author

goetzk commented Mar 27, 2025

I need to think about where this fits in, there's a lot of overlap with the contributing doc: https://docs.pyinfra.com/en/3.x/contributing.html, might be best to expand there?

There is definitely overlap and I'm really not sure of the best angle to approach. The perspective I took with this PR was "What did I need to know/do in order to create an installable custom connector package", and left stub bits in to explain how (eg) custom libraries and facts could be added to that same installable package.

Perhaps what really drives this PR is 'how can custom pyinfra bits be made easily distributable'. If thats a question you want answered in the documentation it would lead to a restructuring of what I've done along these lines:

  • docs/extending.rst retitled something like 'packaging custom code'
  • custom libraries, custom facts, custom connectors, tests sections all removed from the page
  • exceptions section moved elsewhere? unsure
  • debugging section moved elsewhere?

Then I imagine writing operations/facts/connectors would all have a footnote added saying 'look at packaging plugins section for information on making your code distributable'

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