Improve preview generation, matrix mentions and image support #27
Conversation
This file contains 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
This change redesigns the interface of plugins which are now expected to
provide two methods:
- format_content
which takes the parsed markdown content and returns a
(formatted_content, preview, warnings) tuple, in which
- formatted_content is a plugin-specific object,
- preview is the plugin's best string representation of what a post generated
by it would look like
- warnings is a string of any plugin-specific warning messages that were
produced during processing of the content
- create_post
which takes the formatted_content generated by format_content and
submits it as a post to the respective platform;
returns a success, link tuple, where success can be true or false, and
link is a link to the generated post on the platform or None if no link
is available
Matrix mentions are now formatted much more according to the matrix
specs (including the mentioned user's display name if it can be found)
and will now display correctly in at least two clients (element and
nheko). Likewise, images are now uploaded in a format compatible with
both of these clients.
This commit updates the dependencies in the `requirements.txt` file. It also updates the GitHub Actions workflows (`preview.yml` and `publish_content.yml`) to use the latest versions of the `actions/checkout` and `actions/setup-python` actions. The Python version in the workflows is updated to `3.12` (this was necessary for using `asyncio.Runner()`) . These changes aim to improve the overall functionality and compatibility of the project.
|
@wm75 Thank you. This is a great idea. I have rewritten the BlueSky and Slack plugins with the same functionality. |
Oh, hadn't thought of that, thanks for catching it! and thanks for all the other work, I'll take a look now. |
wm75
commented
Jun 5, 2024
|
... and feel free to approve and merge |
arash77
approved these changes
Jun 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This change redesigns the interface of plugins which are now expected to provide two methods:
format_content
which takes the parsed markdown content and returns a (formatted_content, preview, warnings) tuple, in which
create_post
which takes the formatted_content generated by format_content and submits it as a post to the respective platform;
returns a success, link tuple, where success can be true or false, and link is a link to the generated post on the platform or None if no link is available
Matrix mentions are now formatted much more according to the matrix specs (including the mentioned user's display name if it can be found) and will now display correctly in at least two clients (element and nheko). Likewise, images are now uploaded in a format compatible with both of these clients.
This is still incomplete as I haven't rewritten the bluesky, linkedin and slack plugins (which I cannot test) yet, but I hope the code and description are clear enough that you can complete the work @arash77 ?