Commit 3ecc7c95 authored by Paul McCarthy's avatar Paul McCarthy
Browse files

Making props package installable via pip

parent 64dde00e
Props library, 2014, The University of Oxford (the "Software")
The Software remains the property of the University of Oxford ("the
The Software is distributed "AS IS" under this Licence solely for
non-commercial use in the hope that it will be useful, but in order
that the University as a charitable foundation protects its assets for
the benefit of its educational and research purposes, the University
makes clear that no condition is made or to be implied, nor is any
warranty given or to be implied, as to the accuracy of the Software,
or that it will be suitable for any particular purpose or for use
under any specific conditions. Furthermore, the University disclaims
all responsibility for the use which is made of the Software. It
further disclaims any liability for the outcomes arising from using
the Software.
The Licensee agrees to indemnify the University and hold the
University harmless from and against any and all claims, damages and
liabilities asserted by third parties (including claims for
negligence) which arise directly or indirectly from the use of the
Software or the sale of any products based on the Software.
No part of the Software may be reproduced, modified, transmitted or
transferred in any form or by any means, electronic or mechanical,
without the express permission of the University. The permission of
the University is not required if the said reproduction, modification,
transmission or transference is done without financial return, the
conditions of this Licence are imposed upon the receiver of the
product, and all original and amended source code is included in any
transmitted product. You may be held legally responsible for any
copyright infringement that is caused or encouraged by your failure to
abide by these terms and conditions.
You are not permitted under this Licence to use this Software
commercially. Use for which any financial return is received shall be
defined as commercial use, and includes (1) integration of all or part
of the source code or the Software into a product for sale or license
by or on behalf of Licensee to third parties or (2) use of the
Software or any derivative of it for research with the final aim of
developing software products for sale or license to a third party or
(3) use of the Software or any derivative of it for research with the
final aim of developing non-software products for sale or license to a
third party, or (4) use of the Software to provide any service to an
external organisation for which payment is received. If you are
interested in using the Software commercially, please contact Isis
Innovation Limited ("Isis"), the technology transfer company of the
University, to negotiate a licence. Contact details are: quoting reference BS/9564.
The props package uses python descriptors to implement an event programming
framework. It also includes the ability for automatic CLI generation and,
optionally, automatic GUI generation (if wxPython is present).
Example usage:
>>> import props
>>> class PropObj(props.HasProperties):
>>> myProperty = props.Boolean()
>>> myPropObj = PropObj()
# Access the property value as a normal attribute:
>>> myPropObj.myProperty = True
>>> myPropObj.myProperty
>>> True
# access the props.Boolean instance:
>>> myPropObj.getProp('myProperty')
>>> <props.prop.Boolean at 0x1045e2710>
# access the underlying props.PropertyValue object
# (there are caveats for List properties):
>>> myPropObj.getPropVal('myProperty')
>>> <props.prop.PropertyValue instance at 0x1047ef518>
# Receive notification of property value changes
>>> def myPropertyChanged(value, *args):
>>> print('New property value: {}'.format(value))
>>> myPropObj.addListener(
>>> 'myProperty', 'myListener', myPropertyChanged)
>>> myPropObj.myProperty = False
>>> New property value: False
# Remove a previously added listener
>>> myPropObj.removeListener('myListener')
#!/usr/bin/env python
# - setuptools configuration for installing the props package.
# Author: Paul McCarthy <>
from setuptools import setup
from setuptools import find_packages
description='Python descriptor framework',
author='Paul McCarthy',
'Development Status :: 3 - Alpha',
'Intended Audience :: Developers',
'License :: Free for non-commercial use',
'Programming Language :: Python :: 2.7',
'Topic :: Software Development :: Libraries :: Python Modules'],
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment