telserv

A telnet server package


License
Other
Install
pip install telserv==0.1.2

Documentation

TelServ - A BBS python library.

Overview


TelServ is a python 3.x library designed to make hosting Telnet servicies/BBses easier.

Usage


Getting it


TelServ will be able to be installed via PiP like this:

pip install telserv

but for now, please just download the file because I'm having trouble with PiP.

Using it


Simply import the library:

import telserv as tel

And that's it!

Start coding

The way TelServ works is creating a server object and passing in a "main" function that contains the code for the BBS. like this:

def main(line):
    # Code goes here...
server = tel.TelnetServer(main)

Notice that the main function takes an argument: "line", the line variable is what allows you to interact with the command line.

The type of the line argument is CommandLine, and here are all of it's functions:

def main(line):
    line.print('line.print prints the text passed in as an argument, And it also supports ANSI sequences.')
    
    line.printnonew('line.printnonew is the same as line.print, except it does not add the newline at the end.\r\n')
    
    line.printbb('[b]line.printbb[/b] prints [b][color=31]BB[/color][color=34]code[/color]![/b]')
    
    # line.printbbnonew is self-explanitory.
    
    # line.printfile('directory\\of\\ansi\\art.ans')
    
    line.printbb('[b]Username: [color=31]')
    username = line.input() # Take input and stop when recieving '\r\n' which is the return key. ( '\r\n' is the default if there's no argument. )
    
    line.printbb('[/color]Password: [color=34]')
    password = line.inputhidden('*') # Take input just like line.input() but display each character as an asterisk.
    
    line.printbb('[/color][color=33]Logged in![/color]')

server = tel.TelnetServer(main)
server.start()