Metadata-Version: 1.1
Name: LabKey
Version: 0.24
Summary: Python client API for LabKey Server
Home-page: https://www.labkey.org/wiki/home/Documentation/page.view?name=python
Author: Brian Connolly
Author-email: brian@labkey.com
License: Apache License 2.0
Download-URL: http://www.labkey.com/download-labkey-server
Description: ===========
        LabKey Python Client API
        ===========
        
        The LabKey package is designed to simplify querying and manipulating data in a LabKey Server. Its APIs are modeled after the LabKey Server 
        JavaScript APIs of the same names.
        
        
        Installation
        ===========
        
        The LabKey package, currently, can only be installed via source. To install the package
        
        1. Download the distribution from http://www.labkey.com/download-labkey-server
        
        2. The package distribution will be named similar to LabKey-0.22.zip, where 
        
            - 0.22 is the python package number
        
        3. Unzip the downloaded package and execute::
            
            python setup.py install 
            
        
        
        Setup Prerequisite
        -------------
        
        In order to the use the LabKey Python Client API, you will need to specify your login credentials in a credential file. The package assumes that this file will be located either 
        
        1. ``$HOME/.labkeycredentials.txt``
        
        2. It location will be specified in the ``LABKEY_CREDENTIALS`` environment variable. 
        
        
        The labkeycredentials file must be in the following format. (3 separate lines)::
            machine https://hosted.labkey.com
            login labkeypython@gmail.com
            password python
        
        where 
        
        - machine: is the URL of your LabKey Server
        
        - login: is the email address to be used to login to the LabKey Server
        
        - password: is the password associated with the login
        
        A sample ``labkeycredentials`` file has been shipped with the source package and named ``.labkeycredentials.sample``
        
        
        Compatibility
        ===========
        Tested against 
        
        - Python 2.6.x, 2.7.x
        
        - LabKey Server v11.1 and later
        
        
        Free, Hosted Test Server
        ===========
        
        The sample login information provided above for the hosted.labkey.com server provides you with read access only.  This level of access is sufficient for only selectRows and executeSql. To test the other APIs on this server, please contact us at https://www.labkey.com/company/contact-us.  LabKey Software will happily provide you with a private, free project on this server to use for testing.
        
        Further details at http://www.labkey.com/hosted/labkey-hosted
        
        
        Help and Contributing
        =========
        
        The `LabKey Python Client API`_ and the LabKey Server are maintained by the LabKey Software Foundation. If you have any questions or need support, please use the `LabKey Server support forum`_. 
        
        
        Documentation 
        -------------
        
        - `LabKey Python API`_
        
        - `Setup and configuration for the LabKey Python API`_
        
        - `Using the LabKey Python API_`
        
        - `Documentation for all the LabKey client APIs`_
        
        .. _`LabKey Python API`: https://www.labkey.org/wiki/home/Documentation/page.view?name=python
        .. _`Setup and configuration of the LabKey Python API`: https://www.labkey.org/wiki/home/Documentation/page.view?name=pythonSetup
        .. _`Using the LabKey Python API`: https://www.labkey.org/wiki/home/Documentation/page.view?name=pythonUsing
        .. _`Documentation for all the LabKey client APIs`: https://www.labkey.org/wiki/home/Documentation/page.view?name=viewAPIs
        .. _`LabKey Python Client API`: https://www.labkey.org/wiki/home/Documentation/page.view?name=python
        .. _`LabKey Server support forum`: https://www.labkey.org/announcements/home/Server/Forum/list.view?
        
        
        Working with the Source Code
        =========
        
        1. Download the source_ from the `LabKey Software Foundation subversion repository`_
        
        2. Make your changes
        
        3. Bump the version number in the ``setup.py`` file 
        
        4. Update the NEWS.txt file explaining the changes that were made 
        
        You can create a new source distribution by running::
            
            python setup.py sdist 
        
        This will create a new source distribution in the dist subdirectory.
        
        .. _`LabKey Software Foundation subversion repository`: https://www.labkey.org/wiki/home/Documentation/page.view?name=svn
        .. _source: https://hedgehog.fhcrc.org/tor/stedi/trunk/remoteapi/python
        
        
        
        Contributors 
        =========
        
        - Elizabeth Nelson (eknelson@labkey.com)
        
            - Outreach Director at LabKey Software 
        
        - Brian Connolly (brian@labkey.com)
        
            - Consultant at LabKey Software
        
        
        Thanks also too
        =========
        
        
        +++++++++++
        LabKey Python Client API News
        +++++++++++
        
        
        What's New in the LabKey 0.24 package
        ==============================
        
        *Release date: 03/20/2015*
        
        - Fixed bug in updateWiki due to changes in LabKey Server v15.1 
        
        
        What's New in the LabKey 0.23 package
        ==============================
        
        *Release date: 11/24/2014*
        
        - Force all SSL connections to use TLSv1 Protocol or higher. 
          This disables the use of SSLv2(Heartbleed) and SSLv3(Poodle) to 
          protect against the Heartbleed and Poodle vulnerabilities. 
        
        
        What's New in the LabKey 0.22 package
        ==============================
        
        *Release date: 04/15/2014*
        
        - Fixed bug in updateWiki when updating a wiki where Guests have read access
        
        
        What's New in the LabKey 0.21 package
        ==============================
        
        *Release date: 03/30/2012*
        
        - Fixed bug in updateWiki due to changes in LabKey Server v12.1
        
        
        What's New in the LabKey 0.20 package
        ==============================
        
        *Release date: 01/25/2012*
        
        - Fixed authentication bug in labkey.wiki and labkey.messageboard
          functions.
        
        
        What's New in the LabKey 0.19 package
        ==============================
        
        *Release date: 11/02/2011*
        
        - Updated name of the sample labkeycredentials file
        
        - Cleaned up docstring comments in each module file. 
        
        - Checked into the LabKey subversion repository.
        
        
        What's New in the LabKey 0.18 package
        ==============================
        
        *Release date: 10/25/2011*
        
        - Created README.txt, MANIFEST.in. Added further package information to 
          setup.py 
        
        - Added empty test directory that will be used in future releases 
          for unit tests
        
        
        What's New in the LabKey 0.16 package
        ==============================
        
        *Release date: Unreleased*
        
        - Ported labkeyquery.py from a stand-alone module to be part of this 
          package. To access the functions that were in labkeyquery.py, you 
          will need to import labkey or import labkey.query
        
        - Added collaboration module which allows programmatic access to 
          wikis and message boards on the LabKey Server
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Topic :: Scientific/Engineering
