1. pystew
  2. citadel

Commits

pystew  committed e31990f

upd

  • Participants
  • Parent commits bad8050
  • Branches default

Comments (0)

Files changed (2)

File LICENSE

  • Ignore whitespace
-Copyright (C) 2010-2011 Louis RIVIERE
-
-Citadel-Python-Client is covered by the MIT license:
-
-Permission is hereby granted, free of charge, to any person
-obtaining a copy of this software and associated documentation
-files (the "Software"), to deal in the Software without restriction,
-including without limitation the rights to use, copy, modify, merge,
-publish, distribute, sublicense, and/or sell copies of the Software,
-and to permit persons to whom the Software is furnished to do so,
-subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included
-in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
-DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
-OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
-OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-

File README

  • Ignore whitespace
-Citadel-Python-Client.
-
-This is a library to access Citadel servers from Python using the Citadel Protocol.
-
-
-          Python : http://www.python.org
-         Citadel : http://www.citadel.org
-Citadel Protocol : http://www.citadel.org/doku.php/documentation:applicationprotocol
-
- - tcp.py defines a fairly generic TCP client in the Client class.
- - api.py implements the Citadel Protocol on top of tcp.Client.
- - citadel.py is the high level Citadel interface.
- - tpl.py contains templates needed by the Citadel client.
-
- You shouldn't have to worry about tcp.py, api.Protocol is the class where you would implement missing parts of the low level Citadel Protocol and citadel.py should be the only module you need to import and adapt to your needs.
-
- When you instenciate the Citadel class, you may pass it a config object (typically a module).
- The config object may have the following attributes:
-  . server_adr  : the Citadel server adr
-  . server_prt  : the Citadel server port
-  . admin_login : admin login           
-  . admin_psw   : admin password       
-  . log         : log file            
-If server_adr is omitted localhost will be used, server_prt defaults to 504.
-If admin login or password are not specified, you will be asked for them as needed.
-If log is not specified (or evaluate to False) nothing will be logged.