Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A JSONRPC-like client and server with additions to enable authenticated requests

Project description

This package provides a service based on JSONRPC with some small additions to the standard in order to enable authenticated requests. The WSGI specification is used for data communication. The package is broken down into two halves - a client and a server. For security, the server is best run over HTTPS, although this is not enforced.

This package depends on WebOb 1.2 (or above). This is automatically installed if you have an internet connection and use pip, otherwise download and install from http://pypi.python.org/pypi/WebOb

Example Usage (Server):

import hashlib
from wsgiref import simple_server
from AuthRPC.server import AuthRPCApp

def myauth(username, password, useragent):
    return username  == 'myuser' and \
           password  == hashlib.md5('secret'.encode()).hexdigest() and \
           useragent == 'myprogram'

class api(object):
    def do_something(self, myvar):
        """Your code placed here"""
        return 'Something', myvar

application = AuthRPCApp(api(), auth=myauth, filepath='/home/myapp/datadir')
server = simple_server.make_server('localhost', 1234, application)
server.serve_forever()

Example Usage (Client):

from AuthRPC.client import ServerProxy, BatchCall

client = ServerProxy('http://localhost:1234/',
                     username='myuser',
                     password='secret',
                     user_agent='myprogram')
retval = client.do_something('test')

# get a file and save local copy
file_contents_generator = client.__getfile__('myfile.pdf')
with open('myfile_downloaded.pdf', 'wb') as f:
    for data in file_contents_generator:
        f.write(data)

batch = BatchCall(client)
batch.do_something('call 1')
batch.do_something('call 2')
batch()

Change Log

0.3.2a

  • Remove dependency on distribute
  • Tidy up pypi package contents

0.3.1a

  • Use generator with __getfile__ (uses much less memory)
  • Fixed security issue with __getfile__ - do not allow access to whole disk!
  • Handle exceptions in auth function
  • Fixed encrypting of no password
  • Changed README code examples

0.3.0a

  • Changed/renamed exceptions that are generated (client)

0.2.0a

  • Added __getfile__ mechanism

0.1.0a

  • Added batch requests
  • Added Python 3 support for server

0.0.1a

  • First version

Project details


Release history Release notifications

This version
History Node

0.3.2a

History Node

0.3.1a

History Node

0.3.0a

History Node

0.2.0a

History Node

0.1.0a

History Node

0.0.1a

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
AuthRPC-0.3.2a.tar.gz (9.0 kB) Copy SHA256 hash SHA256 Source None Oct 19, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page