updated documentation, bumped version to 1.8.2

pybis/src/python/README.md

@@ -220,6 +220,7 @@ sample.p                              # same thing as .props
 sample.p.my_property = "some value"   # set the value of a property (value is checked)
 sample.p + TAB                        # in IPython or Jupyter: show list of available properties
 sample.p.my_property_ + TAB           # in IPython or Jupyter: show datatype or controlled vocabulary
+sample.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
 sample.get_attachments()
 sample.download_attachments()
@@ -263,13 +264,14 @@ o.get_experiments(
 project.get_experiments()
 exp = o.get_experiment('/MY_SPACE/MY_PROJECT/MY_EXPERIMENT')
 
-
+exp.set_props({ key: value})
 exp.props
 exp.p                              # same thing as .props
 exp.p.finished_flag=True
 exp.p.my_property = "some value"   # set the value of a property (value is checked)
 exp.p + TAB                        # in IPython or Jupyter: show list of available properties
 exp.p.my_property_ + TAB           # in IPython or Jupyter: show datatype or controlled vocabulary
+exp.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
 exp.attrs
 exp.a                              # same thing
@@ -345,12 +347,13 @@ dataset.set_components(['20170115220259155-412'])
 dataset.add_components(['20170115220259155-412'])
 dataset.del_components(['20170115220259155-412'])
 
-ds.set_properties({...})
+ds.set_props({ key: value})
 ds.props
 ds.p                              # same thing as .props
 ds.p.my_property = "some value"   # set the value of a property
 ds.p + TAB                        # show list of available properties
 ds.p.my_property_ + TAB           # show datatype or controlled vocabulary
+ds.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
 # complex query with chaining.
 # properties must be in UPPERCASE

pybis/src/python/README.rst

@@ -253,6 +253,7 @@ NOTE: In openBIS, ``samples`` entities have recently been renamed to
     sample.p.my_property = "some value"   # set the value of a property (value is checked)
     sample.p + TAB                        # in IPython or Jupyter: show list of available properties
     sample.p.my_property_ + TAB           # in IPython or Jupyter: show datatype or controlled vocabulary
+    sample.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
     sample.get_attachments()
     sample.download_attachments()
@@ -299,13 +300,14 @@ e.g. ``get_collections``, ``new_collection``, ``get_collection_types``.
     project.get_experiments()
     exp = o.get_experiment('/MY_SPACE/MY_PROJECT/MY_EXPERIMENT')
 
-
+    exp.set_props({ key: value})
     exp.props
     exp.p                              # same thing as .props
     exp.p.finished_flag=True
     exp.p.my_property = "some value"   # set the value of a property (value is checked)
     exp.p + TAB                        # in IPython or Jupyter: show list of available properties
     exp.p.my_property_ + TAB           # in IPython or Jupyter: show datatype or controlled vocabulary
+    exp.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
     exp.attrs
     exp.a                              # same thing
@@ -382,12 +384,13 @@ Datasets
     dataset.add_components(['20170115220259155-412'])
     dataset.del_components(['20170115220259155-412'])
 
-    ds.set_properties({...})
+    ds.set_props({ key: value})
     ds.props
     ds.p                              # same thing as .props
     ds.p.my_property = "some value"   # set the value of a property
     ds.p + TAB                        # show list of available properties
     ds.p.my_property_ + TAB           # show datatype or controlled vocabulary
+    ds.p['my-weird.property-name']    # accessing properties containing a dash or a dot
 
     # complex query with chaining.
     # properties must be in UPPERCASE

pybis/src/python/pybis/__init__.py

 name = 'pybis'
 __author__ = 'Swen Vermeul'
 __email__ = 'swen@ethz.ch'
-__version__ = '1.8.1'
+__version__ = '1.8.2'
 
 from . import pybis
 from .pybis import Openbis

pybis/src/python/pybis/property.py

@@ -74,7 +74,7 @@ class PropertyHolder():
         if name not in self._property_names:
             raise KeyError(
                 "No such property: '{}'. Allowed properties are: {}".format(
-                    name, self._property_names.keys()
+                    name, ", ".join(self._property_names.keys())
                 )
             )
         property_type = self._property_names[name]

pybis/src/python/setup.py

@@ -11,7 +11,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name='PyBIS',
-    version= '1.8.1',
+    version= '1.8.2',
     author='Swen Vermeul |  ID SIS | ETH Zürich',
     author_email='swen@ethz.ch',
     description='openBIS connection and interaction, optimized for using with Jupyter',