Create examples for XMPP server classes
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 6k
- Forks
- 1.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 10
Description
| powdahound reported | |
|---|---|
| Trac ID | trac#3837 |
| Type | enhancement |
| Created | 2009-05-14 15:01:00Z |
There doesn't seem to be any in-depth documentation or [doc/words/examples examples](doc/words/examples examples) for the work that has been done in t.w.p.jabber.xmlstream in the past 2 years. Specifically, the code added in r23376, r24961, and r20997. From what I can tell, these new classes are intended to be used by XMPP server developers, but it is currently unclear how they all fit together.
I could imagine the following examples:
- xmpp_server.py (for r24961 and r20997)
- xmpp_subprotocol.py (for r23376)
A simple server that allowed the [doc/words/examples/xmpp_client.py XMPP client example](doc/words/examples/xmpp_client.py XMPP client example) to connect to it would be great.
Searchable metadata
trac-id__3837 3837
type__enhancement enhancement
reporter__powdahound powdahound
priority__normal normal
milestone__
branch__
branch_author__
status__new new
resolution__None None
component__words words
keywords__documentation documentation
time__1242313260000000 1242313260000000
changetime__1242579338000000 1242579338000000
version__None None
owner__
cc__ralphm cc__thijs
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
Start with doc/words/examples/xmpp_client.py and the XMPP server classes in t.w.p.jabber.xmlstream, then review the work from revisions r23376, r24961, and r20997. Create the proposed xmpp_server.py and xmpp_subprotocol.py examples, including a simple server that accepts the existing XMPP client example, and confirm the examples explain how the classes fit together.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation, networking
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100