matrix-org / matrix-org/matrix-python-sdk
Add example for writing an appservice
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 266
- Forks
- 118
- PR merge metrics
- No merged PRs in 30d
Description
Since this repo is officially still open under the matrix-org account, I would suggest to update any documentation regarding using the SDK libraries for appservice purposes. Since [matrix-doc/issues/1144](https://github.com/matrix-org/matrix-doc/issues/1144) broke the traditional `MatrixClient(url, token, user_id)` usage scenario and there's very little information on how to apply this SDK to work around it, it would be nice with some updated documentation.
(And I know about the nio recommendation, but for people that don't want/need/can use the asyncio library, this would be a good addition).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the repository's existing documentation for SDK usage and the linked matrix-doc/issues/1144 context. Identify where an appservice example belongs and document how to use the Python SDK for an appservice without relying on asyncio. Done means the traditional usage scenario and its workaround are explained with a usable example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100