dAmnViper 3.55

Brief example

Creating a client quickly for dAmn is quite easy using dAmn Viper. Below is one of the simplest examples of a client that simply connects, and tries to stay connected:

from twisted.internet import reactor
from dAmnViper.base import dAmnSock

dAmn = dAmnSock()

dAmn.user.username = 'username'
dAmn.user.password = 'password'
dAmn.autojoin = ['Botdom']

dAmn.teardown = lambda: reactor.stop()

dAmn.start()

if dAmn.flag.connecting:
    reactor.run()

That is all that is required! It is advised that you use the ReconnectingClient class when making applications that connect to dAmn. Chat bots and full clients can be made by extending the ReconnectingClient class to add functionality, as shown in the examples provided.

Prospects

Because an API is being developed at deviantART (don’t tell anyone just yet), I plan on using this API to retrieve an authtoken. However, as it stands, the API is not ideal, as no password grant is supported, and using the usual authorisation methods in place of the password grant requires some very lengthy methods.

It is of course possible to implement things simply using the normal authorisation methods (OAuth2.0 style), but as mentioned, it takes a long time, and it requires users to open a web browser! This is not ideal in the case of a terminal-based application! It’s even somewhat silly in desktop applications.

Loading a web browser should not be required, but if that is the only option, then I will have to choose between using very tedious methods or sticking to the current page scraping methods used.

Dependencies

A further disadvantage is the acquisition of dependencies. This means that applications using dAmn Viper will depend on twisted as well as dAmn Viper.

In addition, if deviantART’s API implements the password grant type, applications will also depend on PyOpenSSL. This is not exactly a great situation for application developers and end users.

It is more of an issue for end users, as they will not want to spend time installing multiple dependencies. This problem can, however, be eleminated by creating installers for applications using dAmn Viper.

As such, this is somewhat a non-point, but it does mean an installer has to be created to achieve easy setup for end users. Fortunately, installers are something which users tend to be ok at using, so long as they aren’t too complicated. Having an installer which downloads and installs multiple dependencies may complicate things too much. We’ll see.

Feedback

Feedback on this branch of dAmn Viper would be very much appreciated. Please send any feedback to my deviantART account via notes, or submit something on github, I dunno.

Thanks for reading.

DISCLAIMER

Disclaimer:

        dAmn Viper is in no way affiliated with or endorsed by deviantART.com.
This is not an official service of deviantART.com. This is an independent
project created by Henry Rapley:
        <http://photofroggy.deviantart.com>

        THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.