Changeset 6914


Ignore:
Timestamp:
01/06/10 12:37:13 (9 years ago)
Author:
pjkersha
Message:

Incomplete - task 6: Put NDG SAML package on PyPI

  • finished epydoc and documentation Makefile
Location:
TI12-security/trunk/ndg_saml
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • TI12-security/trunk/ndg_saml/.pydevproject

    r6625 r6914  
    33 
    44<pydev_project> 
    5 <pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.5</pydev_property> 
    6 <pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Default</pydev_property> 
     5<pydev_property name="org.python.pydev.PYTHON_PROJECT_VERSION">python 2.6</pydev_property> 
     6<pydev_property name="org.python.pydev.PYTHON_PROJECT_INTERPRETER">Python2.6</pydev_property> 
    77<pydev_pathproperty name="org.python.pydev.PROJECT_SOURCE_PATH"> 
    88<path>/ndg_saml</path> 
  • TI12-security/trunk/ndg_saml/documentation

    • Property svn:ignore set to
      *.*
  • TI12-security/trunk/ndg_saml/documentation/Makefile

    r6900 r6914  
    1515# Generate HTML from embedded epydoc text in source code. 
    1616EPYDOC=epydoc 
     17EPYDOC_INDIR=../ndg 
    1718EPYDOC_OUTDIR=. 
    18 EPYDOC_NAME='MyProxy Client' 
     19EPYDOC_NAME='NERC DataGrid SAML 2.0' 
    1920EPYDOC_LOGFILE=epydoc.log 
    20 EPYDOC_FRAMES_OPT=--no-frames 
     21EPYDOC_OPTS=--no-frames --include-log --graph=all -v 
     22ZIP=zip 
     23ZIP_OUTFILE=./documentation.zip 
     24ZIP_INFILES=./*.* 
     25 
    2126epydoc: 
    22         ${EPYDOC} ../myproxy -o ${EPYDOC_OUTDIR} --name ${EPYDOC_NAME} \ 
    23         ${EPYDOC_FRAMES_OPT} --include-log --graph=all -v > ${EPYDOC_LOGFILE} 
     27        ${EPYDOC} ${EPYDOC_INDIR} -o ${EPYDOC_OUTDIR} --name ${EPYDOC_NAME} \ 
     28        ${EPYDOC_OPTS} > ${EPYDOC_LOGFILE} 
    2429         
     30zip: 
     31        ${ZIP} ${ZIP_OUTFILE} ${ZIP_INFILES} 
     32 
    2533clean: 
    2634        rm -f *.txt *.html *.gif 
  • TI12-security/trunk/ndg_saml/ndg/saml/common/__init__.py

    r6901 r6914  
    6969    def qname(self): 
    7070        """Qualified Name for this type 
     71         
    7172        @return: qualified name 
    7273        @rtype: ndg.saml.common.xml.QName 
  • TI12-security/trunk/ndg_saml/ndg/saml/common/xml.py

    r6906 r6914  
    397397        """Set prefix 
    398398        @param value: prefix 
    399         @type: string 
     399        @type value: string 
    400400        @raise TypeError: invalid input value type 
    401401        """ 
     
    416416    def _setLocalPart(self, value): 
    417417        """Set local part 
    418         @param: local part 
    419         @type: string 
     418        @param value: local part 
     419        @type value: string 
    420420        @raise TypeError: invalid input value type 
    421421        """ 
     
    436436    def _setNamespaceURI(self, value): 
    437437        """Set namespace URI 
    438         @param: namespace URI 
    439         @type: string 
     438        @param value: namespace URI 
     439        @type value: string 
    440440        @raise TypeError: invalid input value type 
    441441        """ 
  • TI12-security/trunk/ndg_saml/ndg/saml/saml2/core.py

    r6913 r6914  
    115115    def __init__(self, **kw): 
    116116        """Initialise Attribute Class attributes 
    117         @param **kw: keywords SAMLObject parent instantiation 
    118         @type **kw: dict 
     117        @param kw: keywords SAMLObject parent instantiation 
     118        @type kw: dict 
    119119        """ 
    120120        super(Attribute, self).__init__(**kw) 
     
    151151    def _set_name(self, name): 
    152152        """Set name 
    153         @param: name 
    154         @type: name 
     153        @param name: name 
     154        @type name: basestring 
    155155        @raise TypeError: invalid input value type 
    156156        """ 
     
    174174    def _set_nameFormat(self, nameFormat): 
    175175        """Set name format 
    176         @param: name format 
    177         @type: string 
     176        @param nameFormat: name format 
     177        @type nameFormat: string 
    178178        @raise TypeError: invalid input value type 
    179179        """ 
     
    197197    def _set_friendlyName(self, friendlyName): 
    198198        """Set friendly name 
    199         @param: friendly name 
    200         @type: string 
     199        @param friendlyName: friendly name 
     200        @type friendlyName: string 
    201201        @raise TypeError: invalid input value type 
    202202        """ 
     
    220220    def _set_attributeValues(self, attributeValues): 
    221221        """Set attribute values 
    222         @param: attribute values 
    223         @type: string 
     222        @param attributeValues: attribute values 
     223        @type attributeValues: list/tuple 
    224224        @raise TypeError: invalid input value type 
    225225        """ 
     
    307307    def __init__(self, **kw): 
    308308        """ 
    309         @param **kw: keywords Statement parent class instantiation 
    310         @type **kw: dict 
     309        @param kw: keywords Statement parent class instantiation 
     310        @type kw: dict 
    311311        """ 
    312312        super(AttributeStatement, self).__init__(**kw) 
     
    410410         
    411411        @param value: the time when the authentication took place 
    412         @type: datetime.datetime 
     412        @type value: datetime.datetime 
    413413        @raise NotImplementedError: abstract method 
    414414        ''' 
     
    432432        @param value: the session index between the principal and the  
    433433        authenticating authority 
    434         @type: ? 
     434        @type value: ? 
    435435        @raise NotImplementedError: abstract method 
    436436        ''' 
     
    454454        @param value: the time when the session between the  
    455455        principal and the SAML authority ends 
    456         @type: datetime.datetime 
     456        @type value: datetime.datetime 
    457457        @raise NotImplementedError: abstract method 
    458458        ''' 
     
    476476        @param value: the DNS domain and IP address of the system where  
    477477        the principal was authenticated 
    478         @type: ? 
     478        @type value: ? 
    479479        @raise NotImplementedError: abstract method 
    480480        ''' 
     
    485485         
    486486        @return: the context used to authenticate the subject 
    487         @type: ? 
     487        @rtype: ? 
    488488        @raise NotImplementedError: abstract method 
    489489        ''' 
     
    494494         
    495495        @param value: the context used to authenticate the subject 
    496         @type: ? 
     496        @type value: ? 
    497497        @raise NotImplementedError: abstract method 
    498498        ''' 
     
    608608        """Test for equality against an input decision type 
    609609         
    610         @param version: decision type 
    611         @type version: ndg.saml.saml2.core.DecisionType or basestring 
     610        @param decision: decision type 
     611        @type decision: ndg.saml.saml2.core.DecisionType or basestring 
    612612        @return: True if input and this object match 
    613613        @rtype: bool 
     
    761761        URIs (functionality likely to be deprecated) 
    762762        @type safeNormalizationChars: string 
    763         @param **kw: keywords for the initialisation of the parent classes' 
     763        @param kw: keywords for the initialisation of the parent classes' 
    764764        attributes 
    765         @type **kw: dict 
     765        @type kw: dict 
    766766        ''' 
    767767        super(AuthzDecisionStatement, self).__init__(**kw) 
     
    825825        '''Get normalisation safe chars 
    826826        @return: normalisation safe chars 
    827         @rtype value: basetring 
     827        @rtype: basetring 
    828828        ''' 
    829829        return self.__safeNormalizationChars 
     
    865865         
    866866        @param value: the new Resource attrib value of this statement 
    867         @type: basestring 
     867        @type value: basestring 
    868868        @raise TypeError: input value is incorrect type 
    869869        ''' 
     
    10291029    def __init__(self, **kw): 
    10301030        ''' 
    1031         @param **kw: keywords for initialisation of parent class attributes 
    1032         @type **kw: dict 
     1031        @param kw: keywords for initialisation of parent class attributes 
     1032        @type kw: dict 
    10331033        ''' 
    10341034        super(Subject, self).__init__(**kw) 
     
    10721072    def _setBaseID(self, value): 
    10731073        """Set base identifier 
    1074         @param: base identifier 
    1075         @type: basestring 
     1074        @param value: base identifier 
     1075        @type value: basestring 
    10761076        @raise TypeError: invalid input value type 
    10771077        """  
     
    10941094    def _setNameID(self, value): 
    10951095        """Set name identifier 
    1096         @param: name identifier 
    1097         @type: basestring 
     1096        @param value: name identifier 
     1097        @type value: basestring 
    10981098        @raise TypeError: invalid input value type 
    10991099        """  
     
    11171117        """Set encrypted identifier 
    11181118         
    1119         @param: encrypted identifier 
    1120         @type: any type 
     1119        @param value: encrypted identifier 
     1120        @type value: any type 
    11211121        @raise TypeError: invalid input value type 
    11221122        """  
     
    12501250    def __init__(self, **kw):  
    12511251        ''' 
    1252         @param **kw: keywords to set attributes of parent class 
    1253         @type **kw: dict 
     1252        @param kw: keywords to set attributes of parent class 
     1253        @type kw: dict 
    12541254        ''' 
    12551255        super(AbstractNameIDType, self).__init__(**kw) 
     
    12991299    def _setValue(self, value): 
    13001300        """Set name value 
    1301         @param: name value 
    1302         @type: string 
     1301        @param value: name value 
     1302        @type value: string 
    13031303        @raise TypeError: invalid input value type 
    13041304        """ 
     
    13201320    def _setNameQualifier(self, value):  
    13211321        """Set name qualifier 
    1322         @param: name qualifier 
    1323         @type: string 
     1322        @param value: name qualifier 
     1323        @type value: string 
    13241324        """ 
    13251325        self.__nameQualifier = value 
     
    13381338    def _setSPNameQualifier(self, value):  
    13391339        """Set SP name qualifier 
    1340         @param: SP name qualifier 
    1341         @type: string 
     1340        @param value: SP name qualifier 
     1341        @type value: string 
    13421342        """ 
    13431343        self.__spNameQualifier = value 
     
    13561356    def _setFormat(self, format): 
    13571357        """Set name format 
    1358         @param: name format 
    1359         @type: string 
     1358        @param format: name format 
     1359        @type format: string 
    13601360        @raise TypeError: invalid input value type 
    13611361        """ 
     
    13771377    def _setSPProvidedID(self, value):  
    13781378        """Set SP provided identifier 
    1379         @param: SP provided identifier 
    1380         @type: string 
     1379        @param value: SP provided identifier 
     1380        @type value: string 
    13811381        """ 
    13821382        self.__spProvidedID = value 
     
    15501550         
    15511551        @param value: the date/time before which the assertion is invalid 
    1552         @type: datetime.datetime 
     1552        @type value: datetime.datetime 
    15531553        ''' 
    15541554        if not isinstance(value, datetime): 
     
    15701570        @param value: the date/time on, or after, which the assertion  
    15711571        is invalid 
    1572         @type: datetime.datetime 
     1572        @type value: datetime.datetime 
    15731573        ''' 
    15741574        if not isinstance(value, datetime): 
     
    19191919         
    19201920        @return: subject of this assertion 
    1921         @rtype subject: ndg.saml.saml2.core.Subject 
     1921        @rtype: ndg.saml.saml2.core.Subject 
    19221922        """ 
    19231923        return self.__subject 
     
    20542054    def __init__(self, **kw): 
    20552055        """ 
    2056         @param **kw: keywords for setting attributes of parent class 
    2057         @type **kw: dict 
     2056        @param kw: keywords for setting attributes of parent class 
     2057        @type kw: dict 
    20582058        """ 
    20592059        super(XSStringAttributeValue, self).__init__(**kw) 
     
    20862086    def _setValue(self, value): 
    20872087        """Set value of XS string 
    2088         @param: value 
    2089         @type: string 
     2088        @param value: value 
     2089        @type value: string 
    20902090        @raise TypeError: invalid input value type 
    20912091        """ 
     
    21362136    def __init__(self, **kw): 
    21372137        """ 
    2138         @param **kw: keywords for setting attributes of parent class 
    2139         @type **kw: dict 
     2138        @param kw: keywords for setting attributes of parent class 
     2139        @type kw: dict 
    21402140        """ 
    21412141        super(StatusDetail, self).__init__(**kw) 
     
    22432243    def _setValue(self, value): 
    22442244        ''' 
    2245         @param __value: message text 
    2246         @type __value: basestring 
     2245        @param value: message text 
     2246        @type value: basestring 
    22472247        @raise TypeError: incorrect type for input value 
    22482248        ''' 
     
    24252425    def __init__(self, **kw): 
    24262426        """ 
    2427         @param **kw: keywords to initialise superclass attributes 
    2428         @type **kw: dict 
     2427        @param kw: keywords to initialise superclass attributes 
     2428        @type kw: dict 
    24292429        """ 
    24302430        super(StatusCode, self).__init__(**kw) 
     
    24632463    def _setStatusCode(self, value): 
    24642464        """Set child status code 
    2465         @param __value: status code value 
    2466         @type __value: ndg.saml.saml2.core.StatusCode 
     2465        @param value: status code value 
     2466        @type value: ndg.saml.saml2.core.StatusCode 
    24672467        """ 
    24682468        if not isinstance(value, StatusCode): 
     
    34333433        '''Create assertion URI reference 
    34343434         
    3435         @param **kw: keywords to initialise superclasses 
    3436         @type **kw: dict 
     3435        @param kw: keywords to initialise superclasses 
     3436        @type kw: dict 
    34373437        ''' 
    34383438        super(AssertionURIRef, self).__init__(**kw) 
     
    34613461        '''Get assertion URI 
    34623462         
    3463         @return assertionURI: assertion URI  
    3464         @rtype assertionURI: basestring 
     3463        @return: assertion URI  
     3464        @rtype: basestring 
    34653465        ''' 
    34663466        return self.__assertionURI 
     
    34693469        '''Set assertion URI 
    34703470         
    3471         @param assertionURI: assertion URI 
    3472         @type assertionURI: basestring 
     3471        @param value: assertion URI 
     3472        @type value: basestring 
    34733473        @raise TypeError: incorrect input value type 
    34743474        ''' 
     
    35103510    def __init__(self, **kw): 
    35113511        ''' 
    3512         @param **kw: keywords for superclass initialisation 
    3513         @type **kw: dict 
     3512        @param kw: keywords for superclass initialisation 
     3513        @type kw: dict 
    35143514        ''' 
    35153515        super(AssertionIDRef, self).__init__(**kw) 
     
    36573657        '''Create an authorization evidence type 
    36583658         
    3659         @param **kw: keyword to initialise superclasses 
    3660         @type **kw: dict 
     3659        @param kw: keyword to initialise superclasses 
     3660        @type kw: dict 
    36613661        ''' 
    36623662        super(Evidence, self).__init__(**kw) 
     
    38683868    def _getSafeNormalizationChars(self): 
    38693869        ''' 
    3870         @param value: safe normalisation characters for input into normalisation 
     3870        @return: safe normalisation characters for input into normalisation 
    38713871        of resource URI. 
    3872         @type value: string 
    3873         @raise TypeError: incorrect type for input value 
     3872        @rtype: string 
    38743873        ''' 
    38753874        return self.__safeNormalizationChars 
     
    41244123    def __init__(self, **kw): 
    41254124        ''' 
    4126         @param **kw: keywords for initialisation of superclass 
    4127         @type **kw: dict 
     4125        @param kw: keywords for initialisation of superclass 
     4126        @type kw: dict 
    41284127        ''' 
    41294128        super(StatusResponseType, self).__init__(**kw) 
     
    43064305        """Set issuer of response 
    43074306         
    4308         @param value: issuer of this response  
     4307        @param issuer: issuer of this response  
    43094308        sending this response 
    4310         @type value: ndg.saml.saml2.core.Issuer 
     4309        @type issuer: ndg.saml.saml2.core.Issuer 
    43114310        @raise TypeError: incorrect type for input value 
    43124311        """ 
     
    44124411    def __init__(self, **kw): 
    44134412        ''' 
    4414         @param **kw: keywords to initialise superclass instance 
    4415         @type **kw: dict 
     4413        @param kw: keywords to initialise superclass instance 
     4414        @type kw: dict 
    44164415        '''  
    44174416        super(Response, self).__init__(**kw) 
  • TI12-security/trunk/ndg_saml/ndg/saml/xml/etree.py

    r6913 r6914  
    186186    wraps the PrettyPrint class 
    187187     
    188     @param *arg: arguments to pretty print function 
    189     @type *arg: tuple 
    190     @param **kw: keyword arguments to pretty print function 
    191     @type **kw: dict 
     188    @param arg: arguments to pretty print function 
     189    @type arg: tuple 
     190    @param kw: keyword arguments to pretty print function 
     191    @type kw: dict 
    192192    ''' 
    193193     
     
    534534        """Make a tree of a XML elements based on the attribute statement 
    535535         
    536         @type assertion: saml.saml2.core.AttributeStatement 
    537         @param assertion: Attribute Statement to be represented as an  
     536        @type attributeStatement: saml.saml2.core.AttributeStatement 
     537        @param attributeStatement: Attribute Statement to be represented as an  
    538538        ElementTree Element 
    539539        @type attributeValueElementTreeFactoryKw: dict 
     
    602602        """Make a tree of a XML elements based on the authzDecision statement 
    603603         
    604         @type assertion: saml.saml2.core.AuthzDecisionStatement 
    605         @param assertion: AuthzDecision Statement to be represented as an  
    606         ElementTree Element 
    607         factory 
     604        @type authzDecisionStatement: saml.saml2.core.AuthzDecisionStatement 
     605        @param authzDecisionStatement: AuthzDecision Statement to be represented 
     606        as an ElementTree Element 
    608607        @rtype: ElementTree.Element 
    609608        @return: ElementTree Element 
     
    13151314    def toXML(cls, status): 
    13161315        """Create an XML representation of the input SAML subject object 
    1317         @type subject: saml.saml2.core.Status 
    1318         @param subject: SAML subject 
     1316        @type status: saml.saml2.core.Status 
     1317        @param status: SAML subject 
    13191318        @rtype: ElementTree.Element 
    13201319        @return: subject as ElementTree XML element 
  • TI12-security/trunk/ndg_saml/setup.py

    r6900 r6914  
    77copyright and licence information are included here: 
    88 
    9 Copyright [2005] [University Corporation for Advanced Internet Development, Inc.] 
     9Copyright [2005] [University Corporation for Advanced Internet Development,  
     10Inc.] 
    1011 
    1112Licensed under the Apache License, Version 2.0 (the "License"); 
     
    2627__license__ = "http://www.apache.org/licenses/LICENSE-2.0" 
    2728__contact__ = "Philip.Kershaw@stfc.ac.uk" 
    28 __revision__ = '$Id:$' 
     29__revision__ = '$Id$' 
    2930 
    3031# Bootstrap setuptools if necessary. 
     
    3233use_setuptools() 
    3334from setuptools import setup, find_packages 
    34 import os 
    3535    
    3636_longDescription = """\ 
     
    4646 
    4747setup( 
    48     name =                      'ndg_security_saml', 
     48    name =                      'ndg_saml', 
    4949    version =                   '0.4', 
    5050    description =               ('SAML 2.0 implementation for the NERC DataGrid ' 
     
    5858    license =               'http://www.apache.org/licenses/LICENSE-2.0', 
    5959    packages =                      find_packages(), 
    60     namespace_packages =        [], 
     60    namespace_packages =        ['ndg'], 
    6161    include_package_data =  True, 
    6262    classifiers = [ 
Note: See TracChangeset for help on using the changeset viewer.