source: trunk/MyProxyWebService/setup.py @ 8135

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg-security/trunk/MyProxyWebService/setup.py@8135
Revision 8135, 5.3 KB checked in by pjkersha, 7 years ago (diff)

0.2.2 Release

Fix ws namespace package declaration.

  • Property keywords set to Id
  • Property svn:keywords set to "Id"
Line 
1#!/usr/bin/env python
2"""Distribution Utilities setup program for MyProxy Server Utilities Package
3
4NERC DataGrid Project
5"""
6__author__ = "P J Kershaw"
7__date__ = "21/05/10"
8__copyright__ = "(C) 2010 Science and Technology Facilities Council"
9__license__ = """BSD - See LICENSE file in top-level directory"""
10__contact__ = "Philip.Kershaw@stfc.ac.uk"
11__revision__ = '$Id: $'
12
13# Bootstrap setuptools if necessary.
14try:
15    from setuptools import setup, find_packages
16except ImportError:
17    from ez_setup import use_setuptools
18    use_setuptools()
19    from setuptools import setup, find_packages
20
21
22setup(
23    name =              'MyProxyWebService',
24    version =           '0.2.2',
25    description =       'MyProxy Web Service',
26    long_description =  '''\
27Provides a simple web service interface to MyProxyCA.  MyProxy is a Service for
28managing and issuing PKI based credentials which is part of the Globus Toolkit. 
29MyProxyWebService provides a HTTP based wrapper interface to MyProxy enabling
30HTTP based clients to connect to a MyProxy server and retrieve credentials.
31
32The interface is implemented as a WSGI application which fronts a normal
33MyProxyCA server.  ``myproxy-logon`` and ``myproxy-get-trustroots`` are
34expressed as web service calls.  The WSGI application forwards the requests on
35to the MyProxy server over the usual MyProxy protocol.  The web service
36interface is RESTful using GET and POST operations and the logon interface makes
37uses of HTTP Basic Auth to pass username and pass-phrase credentials.  The
38service is hosted over HTTPS.
39
40The unit tests include a test application served using paster.  Client scripts
41are also available which need no specialised installation or applications, only
42openssl and wget or curl which are typically available on Linux/UNIX based
43systems.
44
45Changes for version 0.2.2
46=========================
47The package hierarchy has been reorganised:
48 * ``myproxy.server.wsgi``: contains middleware to make calls to a MyProxy
49   service using the ``MyProxyClient`` package.  It exposes this interface
50   through the ``environ`` dict so that other middleware or an app can access
51   and use it.
52 * ``myproxy.ws``: contains functionality specific to the web service interface:
53    - ``myproxy.ws.client``: contains all the functionality for web service clients to the MyProxy web service. This includes:
54       + shell scripts (``.sh`` suffix) for logon and get trustroots calls. 
55         These are implemented with openssl and curl.  Alternative
56         implementations are also provided which use wget (``-wget.sh`` suffix)
57         instead of curl.  These scripts have also been tested against an
58         independent Short-Lived Credential Service developed for the Contrail
59         EU FP7 project.
60       + ``myproxy.ws.client.MyProxyWSClient``: is a Python client interface to
61         the web service.  The third party package ``ndg_httpclient`` is needed
62         for this class but note that overall, it is set as an optional install. 
63    - ``myproxy.ws.server``: contains the server side functionality - a set of
64      WSGI middleware and an application to implement logon and get-trustroot
65      web service calls.
66
67Prerequisites
68=============
69This has been developed and tested for Python 2.6 and 2.7.
70
71Installation
72============
73Installation can be performed using easy_install or pip.  Since this package is
74a wrapper to MyProxy, a MyProxy instance must be deployed that this service can
75call and use.
76
77Configuration
78=============
79Examples are contained in ``myproxy.ws.client.test`` and ``myproxy.server.test``.
80''',
81    author =            'Philip Kershaw',
82    author_email =      'Philip.Kershaw@stfc.ac.uk',
83    maintainer =        'Philip Kershaw',
84    maintainer_email =  'Philip.Kershaw@stfc.ac.uk',
85    url =               'http://proj.badc.rl.ac.uk/ndg/wiki/Security/MyProxyWebService',
86    platforms =         ['POSIX', 'Linux', 'Windows'],
87    install_requires =  ['PasteDeploy', 
88                         'PasteScript',
89                         'WebOb', 
90                         'MyProxyClient'],
91    extras_require =    {'Python_client': 'ndg_httpclient'},
92    license =           __license__,
93    test_suite =        'myproxy.ws.test',
94    packages =          find_packages(),
95    package_data =      {
96        'myproxy.ws.test': [
97            'README', '*.cfg', '*.ini', '*.crt', '*.key', '*.pem', 'ca/*.0'
98        ],
99        'myproxy.ws.client': [
100            'README', '*.sh'
101        ],
102        'myproxy.ws.client.test': [
103            'README', '*.cfg'
104        ]
105    },
106    classifiers = [
107        'Development Status :: 4 - Beta',
108        'Environment :: Console',
109        'Environment :: Web Environment',
110        'Intended Audience :: End Users/Desktop',
111        'Intended Audience :: Developers',
112        'Intended Audience :: System Administrators',
113        'Intended Audience :: Science/Research',
114        'License :: OSI Approved :: BSD License',
115        'Natural Language :: English',
116        'Operating System :: Microsoft :: Windows',
117        'Operating System :: POSIX :: Linux',
118        'Programming Language :: Python',
119        'Topic :: Security',
120        'Topic :: Internet',
121        'Topic :: Scientific/Engineering',
122        'Topic :: System :: Distributed Computing',
123        'Topic :: System :: Systems Administration :: Authentication/Directory',
124        'Topic :: Software Development :: Libraries :: Python Modules'
125    ],
126    zip_safe = False
127)
Note: See TracBrowser for help on using the repository browser.