Rework plugin READMEs - #350
Merged
Merged
Conversation
Prepare for release.
This is better as we have YAML snippets which should be indented with 2 spaces.
Plugins can now be installed with pip.
b-rowan
approved these changes
Aug 28, 2025
b-rowan
left a comment
b-rowan
left a comment
Member
There was a problem hiding this comment.
Seems good. Will have to push the v0.2.7 tag to master after this (I'm away right now so it might take me a while, feel free to do this if it will let you).
Collaborator
Author
I did. Unfortunately, the permissions of the PyPI token need to be broadened to allow pushing the plugins as well. |
Member
|
Will work on that when I have a chance |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Plugins can soon be installed with pip.
As the plugins are not marked as optional in the main pyproject.toml (which IMHO is fine), they are automatically installed when running
poetry install. So, I don't think it's necessary to document the Poetry use case here.As the content of these READMEs is also uploaded to PyPI (https://test.pypi.org/project/goosebit-simple-stats/), we should rather document how to install from package.
If you disagree, I am open to suggestions.