1. pypyr
  2. docs
  3. contributing
  4. contribute to pypyr

contribute to pypyr permalink

pypyr is open source. Your contributions are most welcome.

Feel free to join the pypyr discussion on the pypyr community discussion forum.

bugs permalink

Well, you know. No one’s perfect. Feel free to create an issue.

documentation permalink

You don’t have to code to contribute to open source software. Improving & expanding documentation is a very important part of the process!

All content lives in markdown (.md) files, so you don’t have to be particularly code orientated to interact with the copy editing.

hugo generates the pypyr documentation website you’re reading right now from the pypyr/docs repo.

An easy way to find the source for content you want to edit is to browse the website at pypyr.io and clicking the edit me link under feedback on the right of the page - this will hyperlink you into the exact .md page to edit.

contribute to the core cli permalink

The usual jazz - create an issue, fork, code, test, PR. It might be an idea to discuss your idea on the discussion forum or via the Issues list first before you go off and write a huge amount of code - you never know, something might already be in the works, or maybe it’s not quite right for the core-cli (you’re still welcome to fork and go wild regardless, of course, it just mightn’t get merged back in here).

roll your own plug-in permalink

You’ve probably noticed by now that pypyr is built to be pretty extensible. You’ve probably also noticed that the core pypyr cli is deliberately kept light. The core cli is philosophically only a way of running a sequence of steps. Dependencies to external libraries should generally get their own package, so end-users can selectively install what they need rather than have a monolithic batteries-included application.

If you’ve got some custom context_parser or steps code that are useful, create a repo and bask in the glow of sharing with the open source community. Honor the pypyr Apache license please.

I generally name plug-ins pypyr-myplugin, where myplugin is likely some sort of dependency that you don’t want in the pypyr core cli. For example, pypyr-aws contains pypyr steps for the AWS boto3 library. This is kept separate so that you don’t have to deal with yet another dependency you don’t need if your current project isn’t using AWS.

If you want, for cred on the official plug-in list, please feel free to get in touch via the Feedback link on this page. Get in touch on twitter anyway, would love to hear from you!

last updated on .