Skip to content

The documentation of the library seems entirely broken #149

@George3d6

Description

@George3d6

Asyncio example:

import asyncio
from neonize.aioze.client import NewAClient
from neonize.aioze.events import MessageEv, ConnectedEv

async def main():
    client = NewAClient("async_bot")
    
    @client.event
    async def on_message(client: NewAClient, event: MessageEv):
        if event.message.conversation == "ping":
            await client.reply_message("pong! 🏓", event.message)
    
    await client.connect()

asyncio.run(main())

Literally nothing happens, just runs with no outputs and stops, no db file is created, no errors logs, an unused ConnectedEv

Adding an await event.wait() (`from neonize.aioze.events import event) makes it run ... but, no auth seq is initiated so it's... well, idk what it's doing, certainly not working.


The Basic client setup example

Crashes with:

Traceback (most recent call last):
  File "/Users/george/granadahealth/codebase/be/wttp.py", line 9, in <module>
    client = NewClient(
             ^^^^^^^^^^
TypeError: NewClient.__init__() got an unexpected keyword argument 'database'

The quick start is broken to (see #148 ) -- it's rather hard to tell if this is because the wrapper is no longer up to date with the underlying library or just lacks documentation (the "docs" link is a list of method, functions and types --- so it doesn't much help)

As it stands it's hard to figure out if this is a 99% working library where no attention went into documenting it or a completely forgotten project that would require a lot of maintenance to bring up to speed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions